Struct ScopeRecord 

#[non_exhaustive]
pub struct ScopeRecord {
    pub scope_ref: String,
    pub scope_epoch: u64,
    pub kind: ScopeKind,
    pub bind_proof_sha256: Option<String>,
    pub replace_only_if_idle: bool,
    pub expires_at_ms: Option<u64>,
    pub parent: Option<ScopeParent>,
    pub child_owners: Vec<Principal>,
    pub carriers: Vec<ScopeCarrier>,
    pub attributes: ScopeAttributes,
}

One scope as its owner registers it in scope.sync or scope.apply.

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.

scope_ref: String

scope_epoch: u64

Owner-supplied session number. The owner keeps it with its own record of the session, re-sends the same value for the same session after any restart, and uses a higher one when it reuses the ref for a new session.

kind: ScopeKind

bind_proof_sha256: Option<String>

Only the holder of the scope’s bind proof can bind it when this hash is present. Without a hash, admission is unchanged and proofs are ignored.

replace_only_if_idle: bool

Refuse an epoch replacement or bind-proof change while routes are bound to the live epoch, including binds admitted but not yet committed, or connected presence holders remain. Send only after capability discovery. This is a request condition, not a stored scope attribute.

expires_at_ms: Option<u64>

Absolute Unix wall-clock deadline in milliseconds. It cannot be added, changed or removed within this scope epoch; absent means no deadline. This is not an authority attribute.

parent: Option<ScopeParent>

child_owners: Vec<Principal>

Principals, other than the owner, allowed to register child scopes under this one. Listing a principal here grants it nothing else.

carriers: Vec<ScopeCarrier>

attributes: ScopeAttributes

Implementations

impl ScopeRecord

pub fn new( scope_ref: impl Into<String>, scope_epoch: u64, kind: ScopeKind, ) -> Self

pub fn with_bind_proof_sha256(self, hash: Option<String>) -> Self

pub fn with_replace_only_if_idle(self, replace_only_if_idle: bool) -> Self

pub fn with_expires_at_ms(self, expires_at_ms: Option<u64>) -> Self

pub fn with_parent(self, parent: Option<ScopeParent>) -> Self

pub fn with_child_owners(self, child_owners: Vec<Principal>) -> Self

pub fn with_carriers(self, carriers: Vec<ScopeCarrier>) -> Self

pub fn with_attributes(self, attributes: ScopeAttributes) -> Self

Trait Implementations

impl Clone for ScopeRecord

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 ScopeRecord

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScopeRecord

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ScopeRecord

impl PartialEq for ScopeRecord

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ScopeRecord

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 ScopeRecord