ResourceClient

Struct ResourceClient 

Source
pub struct ResourceClient<T: ActorEntity> {
    sender: Sender<ResourceRequest<T>>,
}
Expand description

A type-safe client for interacting with a ResourceActor.

§ResourceClient

The ResourceClient<T> provides a type‑safe, async API for interacting with a ResourceActor<T>. It forwards CRUD + Action requests over a Tokio mpsc channel and returns results via oneshot channels. The client is cheap to clone and can be shared across tasks.

  • Cloneable – holds only a sender, so cloning is inexpensive.
  • Async API – all methods return Futures that resolve to Result<…, FrameworkError>.
  • Generic – works with any entity that implements ActorEntity.

Fields§

§sender: Sender<ResourceRequest<T>>

Implementations§

Source§

impl<T: ActorEntity> ResourceClient<T>

Source

pub fn new(sender: Sender<ResourceRequest<T>>) -> Self

Source

pub async fn create(&self, params: T::Create) -> Result<T::Id, FrameworkError>

Source

pub async fn get(&self, id: T::Id) -> Result<Option<T>, FrameworkError>

Source

pub async fn update( &self, id: T::Id, update: T::Update, ) -> Result<T, FrameworkError>

Source

pub async fn delete(&self, id: T::Id) -> Result<(), FrameworkError>

Source

pub async fn perform_action( &self, id: T::Id, action: T::Action, ) -> Result<T::ActionResult, FrameworkError>

Trait Implementations§

Source§

impl<T: Clone + ActorEntity> Clone for ResourceClient<T>

Source§

fn clone(&self) -> ResourceClient<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<T> Freeze for ResourceClient<T>

§

impl<T> RefUnwindSafe for ResourceClient<T>

§

impl<T> Send for ResourceClient<T>

§

impl<T> Sync for ResourceClient<T>

§

impl<T> Unpin for ResourceClient<T>

§

impl<T> UnwindSafe for ResourceClient<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more