Enum SessionConfigOptionValue 

#[non_exhaustive]
pub enum SessionConfigOptionValue {
    Id {
        value: SessionConfigValueId,
    },
    Boolean {
        value: bool,
    },
    Other(OtherSessionConfigOptionValue),
}

Available on crate feature unstable_protocol_v2 only.

The value to set for a session configuration option.

The type field acts as the discriminator in the serialized JSON form.

The type discriminator describes the shape of the value, not the option kind. For example every option kind that picks from a list of ids (select, radio, …) would use Id, while a future freeform text option would get its own variant.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Id

A SessionConfigValueId string value (type: "id").

Fields

value: SessionConfigValueId

The value ID.

Boolean

A boolean value (type: "boolean").

Fields

value: bool

The boolean value.

Other(OtherSessionConfigOptionValue)

Custom or future session configuration option value payload.

Values beginning with _ are reserved for implementation-specific extensions. Unknown values that do not begin with _ are reserved for future ACP variants.

Implementations

impl SessionConfigOptionValue

pub fn id(id: impl Into<SessionConfigValueId>) -> Self

Create an id option value (used by select and other id-based option types).

pub fn boolean(val: bool) -> Self

Create a boolean option value.

pub fn as_id(&self) -> Option<&SessionConfigValueId>

Return the inner SessionConfigValueId if this is a Id value.

pub fn as_bool(&self) -> Option<bool>

Return the inner bool if this is a Boolean value.

Trait Implementations

impl Clone for SessionConfigOptionValue

fn clone(&self) -> SessionConfigOptionValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionConfigOptionValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionConfigOptionValue

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SessionConfigOptionValue

impl From<&str> for SessionConfigOptionValue

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<SessionConfigValueId> for SessionConfigOptionValue

fn from(value: SessionConfigValueId) -> Self

Converts to this type from the input type.

impl From<bool> for SessionConfigOptionValue

fn from(value: bool) -> Self

Converts to this type from the input type.

impl IntoV1 for SessionConfigOptionValue

type Output = SessionConfigOptionValue

The corresponding v1 type.

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

Converts this value into the corresponding v1 type.

impl JsonSchema for SessionConfigOptionValue

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 SessionConfigOptionValue

fn eq(&self, other: &SessionConfigOptionValue) -> 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 SessionConfigOptionValue

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 SessionConfigOptionValue