Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

Typed adopter seam over the portable runtime. The JSON dispatcher remains private to adapters; consumers use typed lifecycle operations here.

Implementations§

Source§

impl Client

Source

pub fn open(config: ClientConfig) -> Result<Self>

Source

pub fn endpoint(&self) -> Result<EndpointInfo>

Source

pub fn workspace_state(&self) -> Result<WorkspaceState>

Source

pub fn create_workspace( &self, display_name: &str, workspace_name: Option<&str>, ) -> Result<WorkspaceInfo>

Source

pub fn begin_join( &self, invitation: &[u8], checkpoint: &[u8], display_name: &str, ) -> Result<JoinRequest>

Source

pub fn stage_admission( &self, authenticated_endpoint: [u8; 32], request: &[u8], ) -> Result<WorkspaceCandidate>

Source

pub fn adopt_admission(&self, snapshot: &[u8]) -> Result<WorkspaceInfo>

Source

pub fn retained_admission( &self, authenticated_endpoint: [u8; 32], request: &[u8], ) -> Result<AdmissionReply>

Source

pub fn stage_join( &self, welcome: &[u8], commits: &[JoinAdmissionStep], ) -> Result<WorkspaceCandidate>

Source

pub fn adopt_join(&self, snapshot: &[u8]) -> Result<WorkspaceInfo>

Source

pub fn member_roster(&self) -> Result<MemberRoster>

Source

pub fn issue_invitation(&self) -> Result<InvitationInfo>

Source

pub fn inspect_invitation( &self, invitation: &[u8], checkpoint: &[u8], ) -> Result<InvitationDetails>

Source

pub fn connectivity(&self) -> Result<ConnectivityReport>

Source

pub fn metrics(&self) -> Result<WorkspaceMetrics>

Source

pub fn network_change(&self) -> Result<()>

Source

pub fn cancel(&self) -> Result<()>

Source

pub fn wait_for_work(&self) -> Result<bool>

Source

pub fn poll_control(&self) -> Result<bool>

Service one queued peer-control exchange and report whether one was served.

Source

pub fn add_address_hint(&self, peer: [u8; 32], address: &str) -> Result<()>

Source

pub fn install_policy( &self, workspace: [u8; 32], revision: u64, endpoints: &[PeerPolicy], ) -> Result<()>

Source

pub fn install_workspace_policy(&self, revision: u64) -> Result<()>

Source

pub fn stage_protected_publication( &self, workspace: [u8; 32], revision: u64, topic: &str, id: [u8; 16], payload: Vec<u8>, ) -> Result<PublicationCandidate>

Source

pub fn adopt_protected_publication( &self, snapshot: &[u8], ) -> Result<DeliveryReport>

Source

pub fn set_interest( &self, workspace: [u8; 32], revision: u64, topic: &str, subscribed: bool, ) -> Result<()>

Source

pub fn poll_interest(&self) -> Result<Option<InterestObservation>>

Source

pub fn publish( &self, workspace: [u8; 32], revision: u64, topic: &str, payload: Vec<u8>, ) -> Result<DeliveryReport>

Source

pub fn poll(&self) -> Result<Option<Publication>>

Source

pub fn poll_recovered_publication(&self) -> Result<Option<RecoveredPublication>>

Source

pub fn fetch_recovery_range( &self, request: RecoveryRangeRequest, ) -> Result<RecoveryRangeStatus>

Source

pub fn poll_recovery_range(&self) -> Result<Option<RecoveryRangeStatus>>

Source

pub fn cancel_recovery_range(&self) -> Result<()>

Source

pub fn stage_recovery_range(&self, retain_until: u64) -> Result<RecoveryStage>

Source

pub fn adopt_recovery(&self, snapshot: &[u8]) -> Result<RecoveryAdoption>

Source

pub fn close(&mut self) -> Result<()>

Trait Implementations§

Source§

impl Drop for Client

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl Forget for Client

§

impl Freeze for Client

§

impl Move for Client

§

impl RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl UnsafeUnpin for Client

§

impl UnwindSafe for Client

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> 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> 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<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 = !

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