Struct Session 

pub struct Session<'a> {
    pub created_at: Datetime,
    pub expires_at: Option<Datetime>,
    pub node_id: CowStr<'a>,
    pub relay_url: Option<UriValue<'a>>,
    pub resource: StrongRef<'a>,
    pub extra_data: Option<BTreeMap<SmolStr, Data<'a>>>,
}

Active real-time collaboration session. Published when joining a collaborative editing session, deleted on disconnect.

Fields

created_at: Datetime

expires_at: Option<Datetime>

Session TTL. Should be refreshed periodically while active.

node_id: CowStr<'a>

iroh NodeId in z-base32 encoding for P2P connection.

relay_url: Option<UriValue<'a>>

DERP relay URL if using relay-only mode (browser clients).

resource: StrongRef<'a>

The resource being collaboratively edited.

extra_data: Option<BTreeMap<SmolStr, Data<'a>>>

Implementations

impl<'a> Session<'a>

pub fn uri( uri: impl Into<CowStr<'a>>, ) -> Result<RecordUri<'a, SessionRecord>, UriError>

impl<'a> Session<'a>

pub fn new() -> SessionBuilder<'a, Empty>

Create a new builder for this type

Trait Implementations

impl<'a> Clone for Session<'a>

fn clone(&self) -> Session<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Collection for Session<'_>

const NSID: &'static str = "sh.weaver.collab.session"

The NSID for the Lexicon that defines the schema of records in this collection.

type Record = SessionRecord

A marker type implementing XrpcResp that allows typed deserialization of records from this collection. Used by AgentSessionExt::get_record to return properly typed responses.

fn nsid() -> Nsid<'static>

Returns the Nsid for the Lexicon that defines the schema of records in this collection.

fn repo_path<'u, T>(rkey: &'u RecordKey<T>) -> RepoPath<'u>

where T: RecordKeyType,

Returns the repo path for a record in this collection with the given record key.

impl<'a> Debug for Session<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for Session<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SessionGetRecordOutput<'_>> for Session<'_>

fn from(output: SessionGetRecordOutput<'_>) -> Self

Converts to this type from the input type.

impl<'a> IntoStatic for Session<'a>

type Output = Session<'static>

The “owned” variant of the type. For Cow<'a, str>, this is Cow<'static, str>, for example.

fn into_static(self) -> Self::Output

Turns the value into an “owned” variant, which can then be returned, moved, etc.

impl<'a> LexiconSchema for Session<'a>

fn nsid() -> &'static str

The NSID for this type’s primary definition

fn def_name() -> &'static str

The definition name within the lexicon document

fn lexicon_doc() -> LexiconDoc<'static>

Generate the lexicon document for this type

fn validate(&self) -> Result<(), ConstraintError>

Validate an instance against lexicon constraints

fn schema_id() -> CowStr<'static>

The schema ID for this type

fn inline_schema() -> bool

Whether this type should be inlined vs referenced

impl<'a> PartialEq for Session<'a>

fn eq(&self, other: &Session<'a>) -> 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<'a> Serialize for Session<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for Session<'a>

impl<'a> StructuralPartialEq for Session<'a>