Struct PinClient

pub struct PinClient { /* private fields */ }

Client for managing pins in the Gevulot system.

Implementations

impl PinClient

pub fn new(base_client: Arc<RwLock<BaseClient>>) -> Self

Creates a new instance of PinClient.

Arguments

• base_client - An Arc-wrapped RwLock of the BaseClient.

Returns

A new instance of PinClient.

pub async fn list(&mut self) -> Result<Vec<Pin>>

Lists all pins.

Returns

A Result containing a vector of pins or an error.

Errors

This function will return an error if the request to the Gevulot client fails.

pub async fn get(&mut self, cid: &str) -> Result<Pin>

Gets a pin by its CID.

Arguments

• cid - The CID of the pin to retrieve.

Returns

A Result containing the pin or an error.

Errors

This function will return an error if the pin is not found or if the request to the Gevulot client fails.

pub async fn create( &mut self, msg: MsgCreatePin, ) -> Result<MsgCreatePinResponse>

Creates a new pin.

Arguments

• msg - The message containing the details of the pin to create.

Returns

A Result containing the response of the create pin operation or an error.

Errors

This function will return an error if the request to the Gevulot client fails.

pub async fn delete( &mut self, msg: MsgDeletePin, ) -> Result<MsgDeletePinResponse>

Deletes a pin.

Arguments

• msg - The message containing the details of the pin to delete.

Returns

A Result containing the response of the delete pin operation or an error.

Errors

This function will return an error if the request to the Gevulot client fails.

pub async fn ack(&mut self, msg: MsgAckPin) -> Result<MsgAckPinResponse>

Acknowledges a pin.

Arguments

• msg - The message containing the details of the pin to acknowledge.

Returns

A Result containing the response of the acknowledge pin operation or an error.

Errors

This function will return an error if the request to the Gevulot client fails.

Trait Implementations

impl Clone for PinClient

fn clone(&self) -> PinClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PinClient

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

Formats the value using the given formatter.