Struct State 

#[non_exhaustive]
pub struct State(/* private fields */);

Opaque server state token (RFC 8620 §1.2).

Returned by /get and /changes methods. Clients echo it back in sinceState / ifInState parameters. Treat as opaque — no structure assumed.

Migrating from String-typed code

Earlier revisions of this crate exposed state fields as pub session_state: String on crate::JmapResponse and similar shapes. The current revision uses the State newtype for type safety. The wire format is unchanged (State is #[serde(transparent)] over String). The Rust API conversions available to callers migrating from String:

• Read as &str: state.as_ref() (via AsRef<str>) or format!("{state}") (via Display).
• Compare to a literal: state == "abc" (via PartialEq<str>).
• Move into an owned String: state.into_inner().
• Borrow as &String: not directly available; use as_ref() to get &str instead.
• Build from &str or String: State::from("abc") or State::from(my_string) (via From<&str> / From<String>).

Callers passing a State to a function that takes String should either change the signature to impl AsRef<str> or call state.into_inner() at the boundary. Callers keying a HashMap<String, _> by state token can either rekey by HashMap<State, _> (State implements Hash + Eq) or call state.into_inner() at insertion / lookup time.

Implementations

impl State

pub fn into_inner(self) -> String

Consumes the value and returns the inner String.

impl State

pub fn new_validated(s: impl Into<String>) -> Result<Self, ValidationError>

Construct a State with RFC 8620 §1.2 validation.

Rejects empty strings. RFC 8620 §1.2 requires State to be non-empty; no character-set restriction is imposed.

Use State::from when the value is known to be valid.

Trait Implementations

impl AsRef<str> for State

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for State

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for State

fn clone(&self) -> State

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for State

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for State

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

Formats the value using the given formatter.

impl Eq for State

impl From<&str> for State

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for State

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for State

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for State

fn eq(&self, other: &State) -> 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 PartialEq<&str> for State

fn eq(&self, other: &&str) -> 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 PartialEq<str> for State

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

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 State