Struct atrium_api::agent::AtpAgent

source · 
pub struct AtpAgent<S, T>
where
    S: SessionStore + Send + Sync,
    T: XrpcClient + Send + Sync,
{
    pub api: Service<Client<S, T>>,
    /* private fields */
}
Available on crate feature agent only.
Expand description

An ATP “Agent”. Manages session token lifecycles and provides convenience methods.

Fields§

§api: Service<Client<S, T>>

Implementations§

source§

impl<S, T> AtpAgent<S, T>
where S: SessionStore + Send + Sync, T: XrpcClient + Send + Sync,

source

pub fn new(xrpc: T, store: S) -> Self

Create a new agent.

source

pub async fn login( &self, identifier: impl AsRef<str>, password: impl AsRef<str> ) -> Result<Session, Error<Error>>

Start a new session with this agent.

source

pub async fn resume_session(&self, session: Session) -> Result<(), Error<Error>>

Resume a pre-existing session with this agent.

Auto Trait Implementations§

§

impl<S, T> !RefUnwindSafe for AtpAgent<S, T>

§

impl<S, T> Send for AtpAgent<S, T>

§

impl<S, T> Sync for AtpAgent<S, T>

§

impl<S, T> Unpin for AtpAgent<S, T>

§

impl<S, T> !UnwindSafe for AtpAgent<S, T>

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

source§

fn from(t: T) -> T

Returns the argument unchanged.

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> References<RawCodec> for T

source§

fn references<R, E>(_c: RawCodec, _r: &mut R, _set: &mut E) -> Result<(), Error>
where R: Read, E: Extend<Cid<64>>,

Scrape the references from an impl Read. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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.