Struct Groups

Source

pub struct Groups { /* private fields */ }

Expand description

Public API gateway for the Groups subsystem.

This type is instantiated once per Network instance and is used to join groups and manage them.

Implementations§

Source §

impl Groups

Public API

Source

pub fn with_key(&self, key: impl Into<GroupKey>) -> GroupBuilder<'_>

Returns a builder for configuring and joining a group with the specified group key.

The group id that will be generated by the builder and joined will be derived according to the rules described in the GroupId type definition. All members of the group must use identical configuration values for all the consensus-relevant parameters, otherwise they will generate different group ids and will not be able to form a bond connection with each other.

Auto Trait Implementations§

§

impl !UnwindSafe for Groups

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

Source §

fn compat(self) -> Compat<T>

Applies the Compat adapter by value. Read more

Source §

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more

Source §

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. 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 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 §