Struct NewSessionResponse 

#[non_exhaustive]
pub struct NewSessionResponse {
    pub session_id: SessionId,
    pub modes: Option<SessionModeState>,
    pub config_options: Option<Vec<SessionConfigOption>>,
    pub meta: Option<Meta>,
}

Response from creating a new session.

See protocol docs: Creating a Session

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

session_id: SessionId

Unique identifier for the created session.

Used in all subsequent requests for this conversation.

modes: Option<SessionModeState>

Initial mode state if supported by the Agent

See protocol docs: Session Modes

config_options: Option<Vec<SessionConfigOption>>

Initial session configuration options if supported by the Agent.

meta: Option<Meta>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl NewSessionResponse

pub fn new(session_id: impl Into<SessionId>) -> Self

Builds NewSessionResponse with the required response fields set; optional fields start unset or empty.

pub fn modes(self, modes: impl IntoOption<SessionModeState>) -> Self

Initial mode state if supported by the Agent

See protocol docs: Session Modes

pub fn config_options( self, config_options: impl IntoOption<Vec<SessionConfigOption>>, ) -> Self

Initial session configuration options if supported by the Agent.

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Trait Implementations

impl Clone for NewSessionResponse

fn clone(&self) -> NewSessionResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NewSessionResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NewSessionResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for NewSessionResponse

impl IntoV2 for NewSessionResponse

Available on crate feature unstable_protocol_v2 only.

type Output = NewSessionResponse

The corresponding v2 draft type.

fn into_v2(self) -> Result<Self::Output>

Converts this value into the corresponding v2 draft type.

impl JsonSchema for NewSessionResponse

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for NewSessionResponse

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NewSessionResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NewSessionResponse