Skip to main content

StartSessionOptions

Struct StartSessionOptions 

Source
pub struct StartSessionOptions {
    pub session_id: Option<String>,
    pub workspace_root: Option<String>,
    pub workspace_roots: Option<Vec<String>>,
    pub model_id: Option<String>,
    pub provider_id: Option<String>,
    pub approval_mode: Option<ApprovalMode>,
    pub config: Option<SessionConfig>,
    pub permission_profile: Option<String>,
    pub require_permission_profile: bool,
    pub recovery_mode: Option<RecoveryMode>,
}
Expand description

Options for MuseClient::start_session. A field left None takes the server’s default, except the workspace: with neither workspace_root nor workspace_roots set, the session has no workspace.

Fields§

§session_id: Option<String>

The new session’s id; the server mints one when None. This never opens an existing session: an id the host already holds or has reserved is refused.

§workspace_root: Option<String>

The session’s working folder, as an absolute path.

§workspace_roots: Option<Vec<String>>

The session’s workspace roots, as absolute paths; the first one is the working folder. When workspace_root is also set, both must name the same folder.

§model_id: Option<String>

The starting model.

§provider_id: Option<String>

The starting provider.

§approval_mode: Option<ApprovalMode>

The starting approval mode, one the host’s configuration defines.

§config: Option<SessionConfig>

Per-session configuration.

§permission_profile: Option<String>

The permission profile to start under, by id; the host’s default applies when None. The host may still commit another profile, so set require_permission_profile to refuse a start that did not apply it.

§require_permission_profile: bool

When true, MuseClient::start_session proves the host committed permission_profile before returning the session: from the start result, else from one session/read. Any other committed profile, or none reported, fails with MuseError::PermissionProfileNotApplied. Setting it without permission_profile is refused before anything is sent. This flag is never sent to the host.

§recovery_mode: Option<RecoveryMode>

Whether the session is built with recovery on or off; the host’s default applies when None.

Trait Implementations§

Source§

impl Clone for StartSessionOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for StartSessionOptions

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for StartSessionOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for StartSessionOptions

Source§

impl PartialEq for StartSessionOptions

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for StartSessionOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.