Struct Window 

pub struct Window<S> {
    pub id: String,
    /* private fields */
}

A handle to an iTerm2 window.

Fields

id: String

The unique window identifier.

Implementations

impl<S: AsyncRead + AsyncWrite + Unpin + Send + 'static> Window<S>

pub fn new(id: String, conn: Arc<Connection<S>>) -> Result<Self>

Create a window handle. Validates the window ID.

pub async fn create_tab( &self, profile_name: Option<&str>, ) -> Result<CreateTabResult>

Create a new tab in this window, optionally using a named profile.

pub async fn activate(&self) -> Result<()>

Activate this window (bring it to the front).

pub async fn close(&self, force: bool) -> Result<()>

Close this window. If force is true, skip the confirmation prompt.

pub async fn get_property(&self, name: &str) -> Result<Option<String>>

Get a window property (e.g. "frame", "fullscreen"). Returns JSON-encoded value.

pub async fn set_property(&self, name: &str, json_value: &str) -> Result<()>

Set a window property. Value must be valid JSON.

pub async fn get_variable(&self, name: &str) -> Result<Option<String>>

Get a window variable by name. Returns JSON-encoded value.

pub fn connection(&self) -> &Connection<S>

Get a reference to the underlying connection.