Struct raftstore::store::RegionSnapshot

[+] Show declaration

pub struct RegionSnapshot<S: Snapshot> {
    snap: Arc<S>,
    region: Arc<Region>,
    apply_index: Arc<AtomicU64>,
    pub max_ts_sync_status: Option<Arc<AtomicU64>>,
}

[−] Expand description

Snapshot of a region.

Only data within a region can be accessed.

Fields

snap: Arc<S>

region: Arc<Region>

apply_index: Arc<AtomicU64>

max_ts_sync_status: Option<Arc<AtomicU64>>

Implementations

impl<S> RegionSnapshot<S> where
    S: Snapshot, [−]

pub fn new<EK>(
    ps: &PeerStorage<EK, impl RaftEngine>
) -> RegionSnapshot<EK::Snapshot> where
    EK: KvEngine, 

pub fn from_raw<EK>(db: EK, region: Region) -> RegionSnapshot<EK::Snapshot> where
    EK: KvEngine, 

pub fn from_snapshot(snap: Arc<S>, region: Arc<Region>) -> RegionSnapshot<S>

pub fn get_region(&self) -> &Region

pub fn get_snapshot(&self) -> &S

pub fn get_apply_index(&self) -> Result<u64>

fn get_apply_index_from_storage(&self) -> Result<u64>

pub fn iter(&self, iter_opt: IterOptions) -> RegionIterator<S>

pub fn iter_cf(
    &self,
    cf: &str,
    iter_opt: IterOptions
) -> Result<RegionIterator<S>>

pub fn scan<F>(
    &self,
    start_key: &[u8],
    end_key: &[u8],
    fill_cache: bool,
    f: F
) -> Result<()> where
    F: FnMut(&[u8], &[u8]) -> Result<bool>, 

pub fn scan_cf<F>(
    &self,
    cf: &str,
    start_key: &[u8],
    end_key: &[u8],
    fill_cache: bool,
    f: F
) -> Result<()> where
    F: FnMut(&[u8], &[u8]) -> Result<bool>, 

fn scan_impl<F>(
    &self,
    it: RegionIterator<S>,
    start_key: &[u8],
    f: F
) -> Result<()> where
    F: FnMut(&[u8], &[u8]) -> Result<bool>, 

pub fn get_start_key(&self) -> &[u8]

pub fn get_end_key(&self) -> &[u8]

impl<S> RegionSnapshot<S> where
    S: Snapshot, [−]

fn handle_get_value_error(
    &self,
    e: EngineError,
    cf: &str,
    key: &[u8]
) -> EngineError

Trait Implementations

impl<S> Clone for RegionSnapshot<S> where
    S: Snapshot, [+]

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<S: Debug + Snapshot> Debug for RegionSnapshot<S>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<S> Peekable for RegionSnapshot<S> where
    S: Snapshot, [+]

[+] Show hidden undocumented items

type DBVector = <S as Peekable>::DBVector

The byte-vector type through which the database returns read values.

fn get_value_opt(
    &self,
    opts: &ReadOptions,
    key: &[u8]
) -> EngineResult<Option<Self::DBVector>>[−]

Read a value for a key, given a set of options.

fn get_value_cf_opt(
    &self,
    opts: &ReadOptions,
    cf: &str,
    key: &[u8]
) -> EngineResult<Option<Self::DBVector>>[−]

Read a value for a key from a given column family, given a set of options.

pub fn get_value(&self, key: &[u8]) -> Result<Option<Self::DBVector>, Error>[−]

Read a value for a key.

pub fn get_value_cf(
    &self,
    cf: &str,
    key: &[u8]
) -> Result<Option<Self::DBVector>, Error>[−]

Read a value for a key from a given column family.

pub fn get_msg<M>(&self, key: &[u8]) -> Result<Option<M>, Error> where
    M: Message + Default, [−]

Read a value and return it as a protobuf message.

pub fn get_msg_cf<M>(&self, cf: &str, key: &[u8]) -> Result<Option<M>, Error> where
    M: Message + Default, [−]

Read a value and return it as a protobuf message.