Skip to main content

CompositionContext

Struct CompositionContext 

Source
pub struct CompositionContext { /* private fields */ }
Expand description

Host context supplied to a composition request. It is not deserialized from the model response and therefore cannot be expanded by model text.

Implementations§

Source§

impl CompositionContext

Source

pub fn new(surface_id: impl Into<String>) -> Result<Self, CompositionError>

Source

pub fn scoped( surface_id: impl Into<String>, session_id: impl Into<String>, principal: impl Into<String>, context_id: impl Into<String>, generation: u64, ) -> Result<Self, CompositionError>

Create a context bound to a session, principal, and monotonic context generation. These values are host-owned and never model-deserializable.

Source

pub fn insert_data( &mut self, handle: TrustedDataHandle, ) -> Result<(), CompositionError>

Source

pub fn insert_action( &mut self, handle: TrustedActionHandle, ) -> Result<(), CompositionError>

Source

pub fn replace_data( &mut self, handle: impl Into<String>, generation: u64, component: Component, ) -> Result<(), CompositionError>

Source

pub fn replace_action( &mut self, handle: impl Into<String>, action: Action, ) -> Result<(), CompositionError>

Source

pub fn revoke_action(&mut self, handle: &str) -> bool

Source

pub fn require_data_handle( &mut self, handle: &str, ) -> Result<(), CompositionError>

Mark a host-owned data projection as mandatory. A model proposal that omits it, duplicates it, or hides it under an unsupported subtree is rejected before a Surface is accepted.

Source

pub fn require_authority_ref( &mut self, handle: &str, ) -> Result<(), CompositionError>

Source

pub fn require_action_handle( &mut self, handle: &str, ) -> Result<(), CompositionError>

Source

pub fn advance_generation( &mut self, generation: u64, ) -> Result<(), CompositionError>

Source

pub fn session_id(&self) -> &str

Source

pub fn principal(&self) -> &str

Source

pub fn context_id(&self) -> &str

Source

pub fn generation(&self) -> u64

Source

pub fn required_authority_refs(&self) -> Vec<String>

Source

pub fn surface_id(&self) -> &str

Source

pub fn prompt(&self) -> Result<CompositionPrompt, CompositionError>

Build a provider-neutral prompt projection. Authoritative strings are nested under untrusted_content; they are data, never instructions.

Trait Implementations§

Source§

impl Clone for CompositionContext

Source§

fn clone(&self) -> CompositionContext

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 CompositionContext

Source§

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

Formats the value using the given formatter. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

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
Source§

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
Source§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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