Skip to main content

User

Struct User 

Source
pub struct User<P: ConsensusPlugin, CP: ConversationPluginsFactory> { /* private fields */ }

Implementations§

Source§

impl<P: ConsensusPlugin, CP: ConversationPluginsFactory> User<P, CP>

Source

pub async fn process_inbound_packet( &self, packet: InboundPacket, ) -> Result<(), UserError>

Process an inbound packet. The User-level entry point owns echo dedup, name-based routing, and the welcome subtopic’s plug-in- factory access. App-message packets are handed off to the session for MLS processing and dispatch.

Source

pub async fn finalize_self_leave( &self, conversation_name: &str, ) -> Result<(), UserError>

User-side completion of LeaveConversation: drop the entry from the registry, clean up the consensus scope, and broadcast removal. The session-side teardown (emit Leaving, delete MLS state) runs inside SessionRunner::dispatch_inbound_result / SessionRunner::poll_freeze_status / SessionRunner::check_pending_join; this method is the cleanup callers run when those signal “registry should be removed” (DispatchOutcome::LeaveRequested or PendingJoinTick::Expired).

Source§

impl<P: ConsensusPlugin, CP: ConversationPluginsFactory> User<P, CP>

Source

pub async fn start_conversation( &mut self, conversation_name: &str, is_creation: bool, ) -> Result<(), UserError>

Source

pub async fn create_conversation_with_config( &mut self, conversation_name: &str, is_creation: bool, config: ConversationConfig, ) -> Result<(), UserError>

Like Self::start_conversation but with a per-conversation config override.

Source

pub async fn leave_conversation( &mut self, conversation_name: &str, ) -> Result<(), UserError>

Leave the conversation. PendingJoin short-circuits to local teardown (no MLS state yet). Otherwise delegates the protocol work to the session-side initiate_self_leave — opens a self-leave consensus session with the leaver’s YES bundled at submit. We stay active until the next steward commit merges the removal; on that commit ProcessResult::LeaveConversation fires.

Source§

impl<P: ConsensusPlugin, CP: ConversationPluginsFactory> User<P, CP>

Source

pub fn lookup_entry( &self, conversation_name: &str, ) -> Result<Option<SessionEntry<P, CP>>, UserError>

Look up a conversation runner. Returns Ok(None) when no runner is registered for conversation_name. Takes the outer read lock briefly to clone the inner Arc, then releases it before the caller acquires the runner’s own lock.

Source

pub fn list_conversations(&self) -> Result<Vec<String>, UserError>

Names of every conversation registered on this User.

Source§

impl<P: ConsensusPlugin, CP: ConversationPluginsFactory> User<P, CP>

Source

pub fn identity_string(&self) -> String

Display form of the local identity, derived from Identity::identity_display. Stable for the lifetime of the User; intended for logs and UI.

Source

pub fn generate_key_package(&self) -> Result<KeyPackageBytes, MlsError>

Generate a single-use key package for our identity. Conversation-free — callable before start_conversation. Delegates to the configured crate::core::ConversationPluginsFactory::generate_key_package.

Source

pub fn drain_lifecycle_events(&self) -> Vec<ConversationLifecycle>

Drain every pending ConversationLifecycle event accumulated since the last call. Returns events in insertion order. Callers (gateway, integrator) invoke this once per polling cycle to discover Created / Removed sessions and wire up per-session event drains via SessionRunner::drain_events.

Source

pub fn set_default_scoring_config(&mut self, config: ScoringConfig)

Override the seed ScoringConfig used for newly-created per-conversation scoring plug-ins. Existing conversations are untouched; their plug-ins already own their live config (joiner-side overwritten by ConversationSync).

Source

pub fn set_default_steward_list_config(&mut self, config: StewardListConfig)

Override the seed StewardListConfig used for newly-created per-conversation steward-list plug-ins. Same lifecycle as Self::set_default_scoring_config.

Source§

impl<P: ConsensusPlugin, CP: ConversationPluginsFactory> User<P, CP>

Source

pub fn new_with_plugins( identity: Box<dyn Identity>, plugins: UserPlugins<P, CP>, transport: SharedDeliveryService, ) -> Self

Auto Trait Implementations§

§

impl<P, CP> !Freeze for User<P, CP>

§

impl<P, CP> !RefUnwindSafe for User<P, CP>

§

impl<P, CP> Send for User<P, CP>

§

impl<P, CP> Sync for User<P, CP>

§

impl<P, CP> Unpin for User<P, CP>

§

impl<P, CP> UnsafeUnpin for User<P, CP>

§

impl<P, CP> !UnwindSafe for User<P, CP>

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<T> Classify for T

Source§

type Classified = T

Source§

fn classify(self) -> T

Source§

impl<T> Declassify for T

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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