Skip to main content

ReadyPayload

mobius_gateway::wire

Struct ReadyPayload

pub struct ReadyPayload {Show 18 fields
    pub gateway_version: String,
    pub machine_name: String,
    pub computer_view: ComputerView,
    pub bots: Vec<BotRecord>,
    pub sessions: Vec<SessionRecord>,
    pub background_approvals: Vec<BackgroundApproval>,
    pub providers: Vec<ProviderStatus>,
    pub provider_instances: Vec<ProviderInstance>,
    pub bot_defaults: Option<VersionedAgentConfig>,
    pub models: Vec<ModelChoice>,
    pub model_providers: BTreeMap<String, String>,
    pub middleware_features: Vec<MiddlewareFeature>,
    pub extensions: Vec<ExtensionRecord>,
    pub contributions: Vec<FrontendContribution>,
    pub max_active_sessions: usize,
    pub session_file_limits: SessionFileLimits,
    pub revisions: BTreeMap<ReadySection, String>,
    pub omitted: BTreeSet<ReadySection>,
}

Expand description

Gateway-wide frontend-safe state sent after authentication.

Fields§

§gateway_version: String

Release version of the connected gateway process.

§machine_name: String

The machine name.

§computer_view: ComputerView

The interactive computer view available to this connection.

§bots: Vec<BotRecord>

The bots.

§sessions: Vec<SessionRecord>

The sessions.

§background_approvals: Vec<BackgroundApproval>

The background approvals.

§providers: Vec<ProviderStatus>

The providers.

§provider_instances: Vec<ProviderInstance>

The provider instances.

§bot_defaults: Option<VersionedAgentConfig>

The bot defaults.

§models: Vec<ModelChoice>

The models.

§model_providers: BTreeMap<String, String>

The model providers.

§middleware_features: Vec<MiddlewareFeature>

The middleware features.

§extensions: Vec<ExtensionRecord>

The extensions.

§contributions: Vec<FrontendContribution>

The contributions.

§max_active_sessions: usize

The max active sessions.

§session_file_limits: SessionFileLimits

The session file limits.

§revisions: BTreeMap<ReadySection, String>

Content revision of each cacheable section.

§omitted: BTreeSet<ReadySection>

Sections sent empty because the client holds them at these revisions or skips them.

Implementations§

impl ReadyPayload

pub fn swap_section(&mut self, other: &mut Self, section: ReadySection)

Exchanges one cacheable section with other.

pub fn restore_omitted(&mut self, held: &mut Self)

Moves the sections the gateway omitted back in from the catalog the client holds.

pub fn update(&mut self, next: Self)

Replaces this held catalog with a newer Ready, keeping the sections it omitted.

pub fn revision(&self, section: ReadySection) -> String

Content revision of one section, comparable across connections to one gateway build.

Trait Implementations§

impl Clone for ReadyPayload

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

impl Debug for ReadyPayload

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ReadyPayload

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for ReadyPayload

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

impl Serialize for ReadyPayload

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for ReadyPayload

Auto Trait Implementations§

impl Freeze for ReadyPayload

impl RefUnwindSafe for ReadyPayload

impl Send for ReadyPayload

impl Sync for ReadyPayload

impl Unpin for ReadyPayload

impl UnsafeUnpin for ReadyPayload

impl UnwindSafe for ReadyPayload

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more