Enum SessionConfigOptionValue 

#[non_exhaustive]
pub enum SessionConfigOptionValue {
    Boolean {
        value: bool,
    },
    ValueId {
        value: SessionConfigValueId,
    },
}

Available on crate features unstable_boolean_config and unstable_protocol_v2 only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

The value to set for a session configuration option.

The type field acts as the discriminator in the serialized JSON form. When no type is present, the value is treated as a SessionConfigValueId via the ValueId fallback variant.

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 ValueId, 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.

Boolean

A boolean value (type: "boolean").

Fields

value: bool

The boolean value.

ValueId

A SessionConfigValueId string value.

This is the default when type is absent on the wire. Unknown type values with string payloads also gracefully deserialize into this variant.

Fields

value: SessionConfigValueId

The value ID.

Implementations

impl SessionConfigOptionValue

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

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

pub fn boolean(val: bool) -> SessionConfigOptionValue

Create a boolean option value.

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

Return the inner SessionConfigValueId if this is a ValueId 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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<SessionConfigOptionValue, <__D as Deserializer<'de>>::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) -> SessionConfigOptionValue

Converts to this type from the input type.

impl From<SessionConfigValueId> for SessionConfigOptionValue

fn from(value: SessionConfigValueId) -> SessionConfigOptionValue

Converts to this type from the input type.

impl From<bool> for SessionConfigOptionValue

fn from(value: bool) -> SessionConfigOptionValue

Converts to this type from the input type.

impl IntoV1 for SessionConfigOptionValue

type Output = SessionConfigOptionValue

The corresponding v1 type.

fn into_v1( self, ) -> Result<<SessionConfigOptionValue as IntoV1>::Output, ProtocolConversionError>

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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SessionConfigOptionValue