Skip to main content

TimelineRoom

Struct TimelineRoom 

Source
pub struct TimelineRoom { /* private fields */ }

Implementations§

Source§

impl TimelineRoom

Source

pub fn timeline_id(&self) -> String

Client-facing timeline id within the current principal.

Source

pub fn name(&self) -> String

Source

pub fn agents(&self) -> HashMap<String, Agent>

Source

pub fn polls(&self) -> HashMap<String, Poll>

Source

pub fn runs(&self) -> HashMap<String, Run>

Source

pub fn nodes(&self) -> HashMap<String, GraphNode>

Source

pub fn edges(&self) -> HashMap<String, GraphEdge>

Source

pub fn file_access_codes(&self) -> HashMap<String, FileAccessCodeMeta>

Short-lived Drive codes for file nodes (hydrate + upload + remint).

Source

pub fn trust_edges(&self) -> HashMap<String, TrustEdge>

Source

pub fn status(&self) -> String

Source

pub fn removed(&self) -> bool

Set when the timeline is deleted while this room is open.

Source

pub fn repository(&self) -> Option<u64>

The owner’s Termite repository personas start from, by id; None when it has none.

Source

pub fn owner(&self) -> String

Who owns the timeline: credentials:{id} or group:{id}.

Source

pub fn group(&self) -> Option<Group>

The group that owns the timeline, whose repositories it takes; None for a person’s.

Source

pub async fn set_repository( &self, repository: Option<&Repository>, ) -> Result<()>

Attach one of the owner’s repositories, or None to detach. Personas’ chat forks of the old one are deleted.

Source

pub fn watch_repository( &self, listener: impl Fn(Option<u64>) + Send + Sync + 'static, ) -> Box<dyn FnOnce() + Send + Sync>

Hear about every repository change, from anyone in the room. Returns a function that stops listening.

Source

pub async fn run_trust(&self, run_id: &str) -> Result<Vec<TrustEdge>>

The trust graph a run ended with: the timeline’s graph as the run started, plus everything it changed. trust_edges is the graph every run starts from.

Source

pub fn hydrate(&self, state: &Value)

Source

pub fn handle_event( &self, packet: &Value, ) -> Option<BoxFuture<'static, Result<()>>>

Applies a domain frame. Returns the work still to do when a file node needs a fresh Drive code; run it to finish applying the frame.

Source

pub fn upsert_graph_node(&self, node: GraphNode) -> GraphNode

Source

pub fn remove_graph_node(&self, id: &str)

Source

pub fn upsert_graph_edge(&self, edge: GraphEdge) -> GraphEdge

Source

pub fn remove_graph_edge(&self, id: &str)

Source

pub async fn upload_file_node( &self, file: Vec<u8>, opts: UploadFileOptions, ) -> Result<UploadedFile>

Upload bytes to the host drive and create/update a durable file node.

Source

pub async fn remint_file_access_code( &self, node_id: &str, ) -> Result<FileAccessCodeMeta>

Source

pub async fn file_for_node(&self, node_id: &str) -> Result<File>

Build a drive::File handle for a graph file node (remints if needed).

Source

pub async fn open_graph_file(&self, node_id: &str) -> Result<FileAccessCodeMeta>

Remint if needed and return the short-lived Drive access code for a file node.

Source

pub fn upsert_agent(&self, identity: Identity) -> Agent

Source

pub fn remove_agent(&self, id: &str)

Source

pub fn upsert_poll(&self, goal: &str, query: Vec<AntFormatOrFormat>) -> Poll

Source

pub fn remove_poll(&self, id: &str)

Source

pub async fn start_run( &self, goal: &str, query: &[AntFormatOrFormat], ) -> Result<String>

Create the poll and queue its run in one request. Resolves the run id; the run itself arrives through the room’s upsert-run delta.

Source

pub async fn abort_run(&self, run_id: &str) -> Result<()>

Source

pub async fn get_chat( &self, hooks: Option<Arc<dyn RoomHooks>>, ) -> Result<TimelineChat>

Lazily mint/open the architect Parrot ChatRoom.

Source

pub async fn open_chat( &self, agent_id: &str, hooks: Option<Arc<dyn RoomHooks>>, ) -> Result<TimelineChat>

Ensure a Parrot chat (architect when agent_id is empty) and connect live. Timeline members join by reference (non-guest); access-code guests use the short-lived code so leave/reap semantics stay correct.

Source

pub async fn connect( authorization: &CredentialsOrApiKey, target_id: &str, opts: ConnectOptions, ) -> Result<(TimelineRoom, Presence)>

Connect to an owned timeline. Principal is resolved server-side from auth (+ optional Group).

Source

pub async fn join( authorization: &CredentialsOrApiKey, access_code: &str, hooks: Option<Arc<dyn Hooks>>, ) -> Result<(TimelineRoom, Presence)>

Methods from Deref<Target = Room>§

Source

pub fn endpoint(&self) -> &str

Source

pub fn ws(&self) -> RoomSocket

Source

pub fn authorization(&self) -> &Authorization

Source

pub fn id(&self) -> &str

Source

pub fn get_presences(&self) -> Vec<Presence>

Source

pub fn get_authorization(&self) -> &CredentialsOrApiKey

The caller’s Credentials or ApiKey from the live authorization pack.

Source

pub fn post(&self, packet: &Value)

Source

pub fn disconnect(&self)

Source

pub async fn generate_access_code(&self) -> Result<String>

Trait Implementations§

Source§

impl Clone for TimelineRoom

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Deref for TimelineRoom

Source§

type Target = Room

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Room

Dereferences the value.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more