Struct ScopeSelector 

#[non_exhaustive]
pub struct ScopeSelector {
    pub owner: Principal,
    pub scope_ref: String,
    pub scope_epoch: Option<u64>,
    pub bind_proof: Option<String>,
    pub hold_presence: bool,
}

The scope a route.open asks to be admitted under.

scope_epoch is optional on the wire only so that leaving it out is refused by name (scope_epoch_required) rather than as a malformed body: every opener must name it, the owner included.

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.

owner: Principal

scope_ref: String

scope_epoch: Option<u64>

bind_proof: Option<String>

Base64url-encoded 32-byte secret, without padding. Ignored for records without a bind-proof hash, so holders may always send their proof.

hold_presence: bool

Keep connection-held presence after an admitted open, even if its route closes. Send only to daemons advertising scope-replace-if-idle/v1.

Implementations

impl ScopeSelector

pub fn new( owner: Principal, scope_ref: impl Into<String>, scope_epoch: Option<u64>, ) -> Self

pub fn with_bind_proof(self, proof: Option<String>) -> Self

pub fn with_hold_presence(self, hold_presence: bool) -> Self

Trait Implementations

impl Clone for ScopeSelector

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScopeSelector

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScopeSelector

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ScopeSelector

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

Formats the value using the given formatter.

impl Eq for ScopeSelector

impl PartialEq for ScopeSelector

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ScopeSelector

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 ScopeSelector