Skip to main content

Team

Struct Team 

Source
pub struct Team<'a> { /* private fields */ }
Expand description

Represents an Aranya Team.

Implementations§

Source§

impl Team<'_>

Source

pub fn team_id(&self) -> TeamId

Return the team’s globally unique ID.

Source

pub async fn close_team(&self) -> Result<()>

Closes the team, preventing any further operations on it.

Source§

impl Team<'_>

Source

pub async fn encrypt_psk_seed_for_peer( &self, peer_enc_pk: &[u8], ) -> Result<Vec<u8>>

Encrypts the team’s QUIC syncer PSK seed for a peer. peer_enc_pk is the public encryption key of the peer device. See PublicKeyBundle::encryption.

Source

pub async fn add_sync_peer( &self, addr: Addr, config: SyncPeerConfig, ) -> Result<()>

Adds a peer for automatic periodic Aranya state syncing.

Source

pub async fn sync_now( &self, addr: Addr, cfg: Option<SyncPeerConfig>, ) -> Result<()>

Immediately syncs with the peer.

If config is None, default values (including those from the daemon) will be used.

Source

pub async fn remove_sync_peer(&self, addr: Addr) -> Result<()>

Removes a peer from automatic Aranya state syncing.

Source§

impl Team<'_>

Source

pub async fn add_device( &self, keys: PublicKeyBundle, initial_role: Option<RoleId>, ) -> Result<()>

Adds a device to the team with an optional initial role.

Source

pub fn device(&self, id: DeviceId) -> Device<'_>

Returns the Device corresponding with id.

Source

pub async fn devices(&self) -> Result<Devices>

Returns the list of devices on the team.

Source§

impl Team<'_>

Source

pub async fn setup_default_roles(&self, owning_role: RoleId) -> Result<Roles>

Sets up the default team roles.

owning_role will be the initial owner of the default roles.

It returns the the roles that were created.

Source

pub async fn role_owners(&self, role: RoleId) -> Result<Roles>

Returns the roles that own role.

Source

pub async fn roles(&self) -> Result<Roles>

Returns all of the roles for this team.

Source§

impl Team<'_>

Source

pub async fn create_label( &self, label_name: Text, managing_role_id: RoleId, ) -> Result<LabelId>

Create a label.

Source

pub async fn delete_label(&self, label_id: LabelId) -> Result<()>

Delete a label.

Source

pub async fn add_label_managing_role( &self, label_id: LabelId, managing_role_id: RoleId, ) -> Result<()>

Add label managing role

Source

pub async fn label(&self, label_id: LabelId) -> Result<Option<Label>>

Returns a label if it exists.

Source

pub async fn labels(&self) -> Result<Labels>

Returns the list of labels on the team.

Trait Implementations§

Source§

impl<'a> Debug for Team<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Team<'a>

§

impl<'a> RefUnwindSafe for Team<'a>

§

impl<'a> Send for Team<'a>

§

impl<'a> Sync for Team<'a>

§

impl<'a> Unpin for Team<'a>

§

impl<'a> UnsafeUnpin for Team<'a>

§

impl<'a> UnwindSafe for Team<'a>

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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<T, U> Upcast<T> for U
where T: UpcastFrom<U>,

Source§

fn upcast(self) -> T

Source§

impl<T, B> UpcastFrom<Counter<T, B>> for T

Source§

fn upcast_from(value: Counter<T, B>) -> T

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