Skip to main content

RegionMapping

Struct RegionMapping 

Source
pub struct RegionMapping {
    pub region: String,
    pub ns: Namespace,
    pub kind: HibernateRegionKind,
    pub mode: L2AccessMode,
}
Expand description

A Hibernate region mapped to a HydraCache namespace.

Fields§

§region: String

Hibernate region name as configured by the app.

§ns: Namespace

HydraCache namespace used on the W1 protocol.

§kind: HibernateRegionKind

Hibernate region kind.

§mode: L2AccessMode

Access mode and consistency contract.

Implementations§

Source§

impl RegionMapping

Source

pub fn new( region: impl Into<String>, ns: Namespace, kind: HibernateRegionKind, mode: L2AccessMode, ) -> Result<Self, ClientProtocolError>

Build an explicit region mapping.

Source

pub fn from_region( region: impl Into<String>, kind: HibernateRegionKind, mode: L2AccessMode, ) -> Result<Self, ClientProtocolError>

Build the default namespace mapping for a Hibernate region.

Source

pub const fn consistency_mapping(&self) -> L2ConsistencyMapping

Return the consistency mapping for this region.

Source

pub fn client_context(&self) -> ClientContext

Return a W1 request context for this region.

Source

pub fn key<I, S>( &self, segments: I, ) -> Result<StructuredKey, ClientProtocolError>
where I: IntoIterator<Item = S>, S: Into<String>,

Build a namespaced structured key for this Hibernate region.

Source

pub fn get(&self, key: StructuredKey) -> ClientRequest

Build a W1 get request for this region.

Source

pub fn put( &self, key: StructuredKey, value: Vec<u8>, ttl_ms: Option<u64>, ) -> ClientRequest

Build a W1 put request for this region.

Source

pub fn invalidate(&self, key: StructuredKey) -> ClientRequest

Build a W1 invalidation request for this region.

Source

pub fn evict_region(&self) -> ClientRequest

Build a W1 region eviction request for this region’s namespace.

Trait Implementations§

Source§

impl Clone for RegionMapping

Source§

fn clone(&self) -> RegionMapping

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RegionMapping

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for RegionMapping

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for RegionMapping

Source§

impl PartialEq for RegionMapping

Source§

fn eq(&self, other: &RegionMapping) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for RegionMapping

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RegionMapping

Auto Trait Implementations§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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