Struct ckb_db_migration::Migrations

source · [−]

pub struct Migrations { /* private fields */ }

Expand description

TODO(doc): @quake

Implementations

impl Migrations

pub fn new() -> Self

TODO(doc): @quake

pub fn add_migration(&mut self, migration: Box<dyn Migration>)

TODO(doc): @quake

pub fn check(&self, db: &ReadOnlyDB) -> Ordering

Check if database’s version is matched with the executable binary version.

Returns

Less: The database version is less than the matched version of the executable binary. Requires migration.
Equal: The database version is matched with the executable binary version.
Greater: The database version is greater than the matched version of the executable binary. Requires upgrade the executable binary.

pub fn expensive(&self, db: &ReadOnlyDB) -> bool

Check if the migrations will consume a lot of time.

pub fn init_db_version(&self, db: &RocksDB) -> Result<(), Error>

Initial db version

pub fn migrate(&self, db: RocksDB) -> Result<RocksDB, Error>

TODO(doc): @quake

Trait Implementations

impl Default for Migrations

fn default() -> Migrations

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

Auto Trait Implementations

impl !RefUnwindSafe for Migrations

impl !Send for Migrations

impl !Sync for Migrations

impl Unpin for Migrations

impl !UnwindSafe for Migrations

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> AsAny for T where
T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

TODO(doc): @quake

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

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

const: unstable · 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.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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.

const: unstable · source

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