Struct raftstore::store::snap::Snap

pub struct Snap {
    key: SnapKey,
    display_path: String,
    dir_path: PathBuf,
    cf_files: Vec<CfFile>,
    cf_index: usize,
    meta_file: MetaFile,
    hold_tmp_files: bool,
    mgr: SnapManagerCore,
}

Fields

key: SnapKey

display_path: String

dir_path: PathBuf

cf_files: Vec<CfFile>

cf_index: usize

meta_file: MetaFile

hold_tmp_files: bool

mgr: SnapManagerCore

Implementations

impl Snap

fn new<T: Into<PathBuf>>(
    dir: T,
    key: &SnapKey,
    is_sending: bool,
    check_policy: CheckPolicy,
    mgr: &SnapManagerCore
) -> RaftStoreResult<Self>

fn new_for_building<T: Into<PathBuf>>(
    dir: T,
    key: &SnapKey,
    mgr: &SnapManagerCore
) -> RaftStoreResult<Self>

fn new_for_sending<T: Into<PathBuf>>(
    dir: T,
    key: &SnapKey,
    mgr: &SnapManagerCore
) -> RaftStoreResult<Self>

fn new_for_receiving<T: Into<PathBuf>>(
    dir: T,
    key: &SnapKey,
    mgr: &SnapManagerCore,
    snapshot_meta: SnapshotMeta
) -> RaftStoreResult<Self>

fn new_for_applying<T: Into<PathBuf>>(
    dir: T,
    key: &SnapKey,
    mgr: &SnapManagerCore
) -> RaftStoreResult<Self>

fn init_for_building(&mut self) -> RaftStoreResult<()>

fn read_snapshot_meta(&mut self) -> RaftStoreResult<SnapshotMeta>

fn set_snapshot_meta(
    &mut self,
    snapshot_meta: SnapshotMeta
) -> RaftStoreResult<()>

fn load_snapshot_meta(&mut self) -> RaftStoreResult<()>

fn get_display_path(dir_path: impl AsRef<Path>, prefix: &str) -> String

fn validate(
    &self,
    engine: &impl KvEngine,
    for_send: bool
) -> RaftStoreResult<()>

fn switch_to_cf_file(&mut self, cf: &str) -> Result<()>

fn save_meta_file(&mut self) -> RaftStoreResult<()>

fn do_build<EK: KvEngine>(
    &mut self,
    engine: &EK,
    kv_snap: &EK::Snapshot,
    region: &Region,
    stat: &mut SnapshotStatistics
) -> RaftStoreResult<()> where
    EK: KvEngine, 

Trait Implementations

impl Debug for Snap

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

Formats the value using the given formatter.

impl Drop for Snap

fn drop(&mut self)

Executes the destructor for this type.

impl GenericSnapshot for Snap

fn path(&self) -> &str

fn exists(&self) -> bool

fn delete(&self)

fn meta(&self) -> Result<Metadata>

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

fn save(&mut self) -> Result<()>

impl Read for Snap

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

pub fn read_vectored(
    &mut self,
    bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

pub fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

pub unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

pub fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

pub fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

pub fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl<EK> Snapshot<EK> for Snap where
    EK: KvEngine, 

fn build(
    &mut self,
    engine: &EK,
    kv_snap: &EK::Snapshot,
    region: &Region,
    snap_data: &mut RaftSnapshotData,
    stat: &mut SnapshotStatistics
) -> RaftStoreResult<()>

fn apply(&mut self, options: ApplyOptions<EK>) -> Result<(), Error>

impl Write for Snap

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

pub fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

pub fn write_all_vectored(
    &mut self,
    bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

pub fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Write.