Skip to main content

WaitForCompactOptions

Struct WaitForCompactOptions 

Source
pub struct WaitForCompactOptions { /* private fields */ }

Implementations§

Source§

impl WaitForCompactOptions

Source

pub fn set_abort_on_pause(&mut self, v: bool)

If true, abort waiting if background jobs are paused. If false, ContinueBackgroundWork() must be called to resume the background jobs. Otherwise, jobs that were queued, but not scheduled yet may never finish and WaitForCompact() may wait indefinitely (if timeout is set, it will abort after the timeout).

Default: false

Source

pub fn set_flush(&mut self, v: bool)

If true, flush all column families before starting to wait.

Default: false

Source

pub fn set_timeout(&mut self, microseconds: u64)

Timeout in microseconds for waiting for compaction to complete. when timeout == 0, WaitForCompact() will wait as long as there’s background work to finish.

Default: 0

Source

pub fn set_wait_for_purge(&mut self, val: bool)

A boolean to wait for purge to complete

Source

pub fn get_wait_for_purge(&self) -> bool

Returns the value of the wait_for_purge option.

Source

pub fn get_abort_on_pause(&self) -> bool

Returns the current abort_on_pause setting.

See Self::set_abort_on_pause for what this controls.

Source

pub fn get_close_db(&self) -> bool

Returns the current close_db setting.

See Self::set_close_db for what this controls.

Source

pub fn get_flush(&self) -> bool

Returns the current flush setting.

See Self::set_flush for what this controls.

Source

pub fn get_timeout(&self) -> u64

Returns the current timeout setting.

See Self::set_timeout for what this controls.

Source

pub fn set_close_db(&mut self, val: bool)

A boolean to call Close() after waiting is done. By the time Close() is called here, there should be no background jobs in progress and no new background jobs should be added. DB may not have been closed if Close() returned Aborted status due to unreleased snapshots in the system. See comments in DB::Close() for details.

Trait Implementations§

Source§

impl Default for WaitForCompactOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for WaitForCompactOptions

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.