Class: Btape::Result

Inherits:
Struct
  • Object
show all
Defined in:
lib/btape/result.rb

Overview

What a run produced. output_path is where the GIF was written, or nil when the caller passed an IO for it to be written into instead.

Callers that want the frames themselves (to attach a still somewhere, say) pass frames_directory: to Runner#run and read frame_paths.

Without a frames_directory: the frames live in a temporary directory that is removed as the run unwinds, so frame_paths and named_frames are empty rather than lists of paths that no longer exist. frame_count is always the number of frames that went into the GIF.

named_frames maps the name a Screenshot NAME command gave a frame to its path, for picking one particular frame out of a run.

Instance Attribute Summary collapse

Instance Attribute Details

#frame_count ⇒ Object

Returns the value of attribute frame_count

Returns:

  • (Object) —

    the current value of frame_count



17
18
19
 
# File 'lib/btape/result.rb', line 17

def frame_count
  @frame_count
end

#frame_paths ⇒ Object

Returns the value of attribute frame_paths

Returns:

  • (Object) —

    the current value of frame_paths



17
18
19
 
# File 'lib/btape/result.rb', line 17

def frame_paths
  @frame_paths
end

#height ⇒ Object

Returns the value of attribute height

Returns:

  • (Object) —

    the current value of height



17
18
19
 
# File 'lib/btape/result.rb', line 17

def height
  @height
end

#named_frames ⇒ Object

Returns the value of attribute named_frames

Returns:

  • (Object) —

    the current value of named_frames



17
18
19
 
# File 'lib/btape/result.rb', line 17

def named_frames
  @named_frames
end

#output_path ⇒ Object

Returns the value of attribute output_path

Returns:

  • (Object) —

    the current value of output_path



17
18
19
 
# File 'lib/btape/result.rb', line 17

def output_path
  @output_path
end

#width ⇒ Object

Returns the value of attribute width

Returns:

  • (Object) —

    the current value of width



17
18
19
 
# File 'lib/btape/result.rb', line 17

def width
  @width
end