Skip to main content

SynapClient

synap_sdk::client

Struct SynapClient

pub struct SynapClient { /* private fields */ }

Expand description

Main Synap client.

Internally uses one of three transports — SynapRPC (default), RESP3, or HTTP — selected via SynapConfig::transport. Commands that have no native-protocol mapping automatically fall back to HTTP regardless of the chosen transport.

Implementations§

impl SynapClient

pub fn new(config: SynapConfig) -> Result<Self>

Create a new Synap client using the provided configuration.

pub fn kv(&self) -> KVStore

Get the Key-Value store interface.

pub fn hash(&self) -> HashManager

Get the Hash manager interface.

pub fn list(&self) -> ListManager

Get the List manager interface.

pub fn set(&self) -> SetManager

Get the Set manager interface.

pub fn sorted_set(&self) -> SortedSetManager

Get the Sorted Set manager interface.

pub fn queue(&self) -> QueueManager

Get the Queue manager interface.

pub fn stream(&self) -> StreamManager

Get the Stream manager interface.

pub fn pubsub(&self) -> PubSubManager

Get the Pub/Sub manager interface.

pub fn transaction(&self) -> TransactionManager

Get the Transaction manager interface.

pub fn script(&self) -> ScriptManager

Get the Scripting manager interface.

pub fn hyperloglog(&self) -> HyperLogLogManager

Get the HyperLogLog manager interface.

pub fn bitmap(&self) -> BitmapManager

Get the Bitmap manager interface.

pub fn geospatial(&self) -> GeospatialManager

Get the Geospatial manager interface.

pub async fn send_command(&self, command: &str, payload: Value) -> Result<Value>

Dispatch a command to the active transport.

For SynapRPC and RESP3 transports every command must have a native mapping in the transport mapper. Unmapped commands return SynapError::UnsupportedCommand — there is no silent HTTP fallback. Use an http:// URL if you need HTTP REST for a command that is not yet in the mapper.

pub fn base_url(&self) -> &Url

Get the configured base URL.

Trait Implementations§

impl Clone for SynapClient

fn clone(&self) -> SynapClient

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 Freeze for SynapClient

impl !RefUnwindSafe for SynapClient

impl Send for SynapClient

impl Sync for SynapClient

impl Unpin for SynapClient

impl UnsafeUnpin for SynapClient

impl !UnwindSafe for SynapClient

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

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

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

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