LibTmux::Workspace::ApplyResult

Members

Effect

Cclass libtmux-workspace [source] ¶

def cleanup_errors: () -> ::Array[::String]

mmethod libtmux-workspace [source] ¶

Returns the value of attribute cleanup_errors.

Description#

Behavior contract: Workspace results.

def compensation: () -> ( :not_requested | :nothing_owned | :completed | :failed )

mmethod libtmux-workspace [source] ¶

Returns the value of attribute compensation.

Description#

Behavior contract: Workspace results.

Examples#

Apply a workspace whose panes cannot fit with compensate: true. The failed split is reported, the created session is removed, and the borrowed session stays. Use Ruby 4.0.7, Bundler, Git and tmux 3.3a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \
  git -C libtmux-source checkout d8ce4bbee0ca7748a81929f81f7d8d07f8c51267

Save this dependency file as Gemfile:

source "https://rubygems.org"

gem "libtmux-workspace", path: "libtmux-source/gems/libtmux-workspace"

Save this complete program as workspace_failure.rb. Its Server.start block owns a private tmux server and stops it on exit, including after an error. View source

# frozen_string_literal: true

begin
  # docs:begin main
  require "json"
  require "libtmux"
  require "libtmux/workspace"

  LibTmux::Server.start do |server|
    server.new_session(name: "borrowed", command: ["/bin/cat"])
    crowded = LibTmux::Workspace.parse(
      JSON.generate({session_name: "crowded", windows: [{window_name: "small", panes: Array.new(40) { {} }}]}),
      format: :json, base_directory: __dir__
    )
    begin
      crowded.plan.apply(server: server, compensate: true)
    rescue LibTmux::Workspace::ApplyError => error
      puts "failed action: #{error.result.failed_action}"
      puts "created a session: #{error.result.created_refs.key?('session')}"
      puts "compensation: #{error.result.compensation}"
    end
    puts "sessions: #{server.list_sessions.map { |session| session.snapshot.name }.join(', ')}"
  end
  # docs:end main
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

Install the runtime dependencies and run the saved program. An operation or cleanup error makes it exit unsuccessfully:

$ bundle config set --local path vendor/bundle && \
  bundle install --jobs 2 && \
  bundle exec ruby workspace_failure.rb

Expected output:

failed action: split_pane
created a session: true
compensation: completed
sessions: borrowed

def completed_steps: () -> ::Array[::Integer]

mmethod libtmux-workspace [source] ¶

Returns the value of attribute completed_steps.

Description#

Behavior contract: Workspace results.

def created_refs: () -> ::Hash[ ::String, ::LibTmux::EntityRef ]

mmethod libtmux-workspace [source] ¶

Returns the value of attribute created_refs.

Description#

Behavior contract: Workspace results.

Examples#

Apply a workspace whose panes cannot fit with compensate: true. The failed split is reported, the created session is removed, and the borrowed session stays. Use Ruby 4.0.7, Bundler, Git and tmux 3.3a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \
  git -C libtmux-source checkout d8ce4bbee0ca7748a81929f81f7d8d07f8c51267

Save this dependency file as Gemfile:

source "https://rubygems.org"

gem "libtmux-workspace", path: "libtmux-source/gems/libtmux-workspace"

Save this complete program as workspace_failure.rb. Its Server.start block owns a private tmux server and stops it on exit, including after an error. View source

# frozen_string_literal: true

begin
  # docs:begin main
  require "json"
  require "libtmux"
  require "libtmux/workspace"

  LibTmux::Server.start do |server|
    server.new_session(name: "borrowed", command: ["/bin/cat"])
    crowded = LibTmux::Workspace.parse(
      JSON.generate({session_name: "crowded", windows: [{window_name: "small", panes: Array.new(40) { {} }}]}),
      format: :json, base_directory: __dir__
    )
    begin
      crowded.plan.apply(server: server, compensate: true)
    rescue LibTmux::Workspace::ApplyError => error
      puts "failed action: #{error.result.failed_action}"
      puts "created a session: #{error.result.created_refs.key?('session')}"
      puts "compensation: #{error.result.compensation}"
    end
    puts "sessions: #{server.list_sessions.map { |session| session.snapshot.name }.join(', ')}"
  end
  # docs:end main
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

Install the runtime dependencies and run the saved program. An operation or cleanup error makes it exit unsuccessfully:

$ bundle config set --local path vendor/bundle && \
  bundle install --jobs 2 && \
  bundle exec ruby workspace_failure.rb

Expected output:

failed action: split_pane
created a session: true
compensation: completed
sessions: borrowed

def effects: () -> ::Array[ ::LibTmux::Workspace::ApplyResult::Effect ]

mmethod libtmux-workspace [source] ¶

Returns the value of attribute effects.

Description#

Behavior contract: Workspace results.

def failed_action: () -> ::Symbol?

mmethod libtmux-workspace [source] ¶

Returns the value of attribute failed_action.

Description#

Behavior contract: Workspace results.

Examples#

Apply a workspace whose panes cannot fit with compensate: true. The failed split is reported, the created session is removed, and the borrowed session stays. Use Ruby 4.0.7, Bundler, Git and tmux 3.3a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \
  git -C libtmux-source checkout d8ce4bbee0ca7748a81929f81f7d8d07f8c51267

Save this dependency file as Gemfile:

source "https://rubygems.org"

gem "libtmux-workspace", path: "libtmux-source/gems/libtmux-workspace"

Save this complete program as workspace_failure.rb. Its Server.start block owns a private tmux server and stops it on exit, including after an error. View source

# frozen_string_literal: true

begin
  # docs:begin main
  require "json"
  require "libtmux"
  require "libtmux/workspace"

  LibTmux::Server.start do |server|
    server.new_session(name: "borrowed", command: ["/bin/cat"])
    crowded = LibTmux::Workspace.parse(
      JSON.generate({session_name: "crowded", windows: [{window_name: "small", panes: Array.new(40) { {} }}]}),
      format: :json, base_directory: __dir__
    )
    begin
      crowded.plan.apply(server: server, compensate: true)
    rescue LibTmux::Workspace::ApplyError => error
      puts "failed action: #{error.result.failed_action}"
      puts "created a session: #{error.result.created_refs.key?('session')}"
      puts "compensation: #{error.result.compensation}"
    end
    puts "sessions: #{server.list_sessions.map { |session| session.snapshot.name }.join(', ')}"
  end
  # docs:end main
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

Install the runtime dependencies and run the saved program. An operation or cleanup error makes it exit unsuccessfully:

$ bundle config set --local path vendor/bundle && \
  bundle install --jobs 2 && \
  bundle exec ruby workspace_failure.rb

Expected output:

failed action: split_pane
created a session: true
compensation: completed
sessions: borrowed

def failed_step: () -> ::Integer?

mmethod libtmux-workspace [source] ¶

Returns the value of attribute failed_step.

Description#

Behavior contract: Workspace results.

def inspect: () -> ::String

mmethod libtmux-workspace [source] ¶

Behavior: Workspace results.

Description#

Behavior contract: Workspace results.

def success?: () -> bool

mmethod libtmux-workspace [source] ¶

Behavior: Workspace results.

Description#

Behavior contract: Workspace results.

def to_h: () -> ::Hash[::String, untyped]

mmethod libtmux-workspace [source] ¶

Behavior: Workspace results.

Description#

Behavior contract: Workspace results.

def uncertain?: () -> bool

mmethod libtmux-workspace [source] ¶

Behavior: Workspace results.

Description#

Behavior contract: Workspace results.