Struct File

Source
pub struct File;
๐Ÿ‘ŽDeprecated
Available on crate feature kv-rocksdb only.
Expand description

File database

ยงExamples

Instantiating a file-backed instance

use surrealdb::Surreal;
use surrealdb::engine::local::File;

let db = Surreal::new::<File>("path/to/database-folder").await?;

Instantiating a file-backed strict instance

use surrealdb::opt::Config;
use surrealdb::Surreal;
use surrealdb::engine::local::File;

let config = Config::default().strict();
let db = Surreal::new::<File>(("path/to/database-folder", config)).await?;

Trait Implementationsยง

Sourceยง

impl Debug for File

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl IntoEndpoint<File> for &Path

Sourceยง

type Client = Db

The client implied by this scheme and address combination
Sourceยง

fn into_endpoint(self) -> Result<Endpoint>

Converts an input into a server address object
Sourceยง

impl IntoEndpoint<File> for &String

Sourceยง

type Client = Db

The client implied by this scheme and address combination
Sourceยง

fn into_endpoint(self) -> Result<Endpoint>

Converts an input into a server address object
Sourceยง

impl IntoEndpoint<File> for &str

Sourceยง

type Client = Db

The client implied by this scheme and address combination
Sourceยง

fn into_endpoint(self) -> Result<Endpoint>

Converts an input into a server address object
Sourceยง

impl IntoEndpoint<File> for (&Path, Config)

Sourceยง

type Client = Db

The client implied by this scheme and address combination
Sourceยง

fn into_endpoint(self) -> Result<Endpoint>

Converts an input into a server address object
Sourceยง

impl IntoEndpoint<File> for (&String, Config)

Sourceยง

type Client = Db

The client implied by this scheme and address combination
Sourceยง

fn into_endpoint(self) -> Result<Endpoint>

Converts an input into a server address object
Sourceยง

impl IntoEndpoint<File> for (&str, Config)

Sourceยง

type Client = Db

The client implied by this scheme and address combination
Sourceยง

fn into_endpoint(self) -> Result<Endpoint>

Converts an input into a server address object
Sourceยง

impl IntoEndpoint<File> for (PathBuf, Config)

Sourceยง

type Client = Db

The client implied by this scheme and address combination
Sourceยง

fn into_endpoint(self) -> Result<Endpoint>

Converts an input into a server address object
Sourceยง

impl IntoEndpoint<File> for (String, Config)

Sourceยง

type Client = Db

The client implied by this scheme and address combination
Sourceยง

fn into_endpoint(self) -> Result<Endpoint>

Converts an input into a server address object
Sourceยง

impl IntoEndpoint<File> for PathBuf

Sourceยง

type Client = Db

The client implied by this scheme and address combination
Sourceยง

fn into_endpoint(self) -> Result<Endpoint>

Converts an input into a server address object
Sourceยง

impl IntoEndpoint<File> for String

Sourceยง

type Client = Db

The client implied by this scheme and address combination
Sourceยง

fn into_endpoint(self) -> Result<Endpoint>

Converts an input into a server address object

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> Instrument for T

Sourceยง

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Sourceยง

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Sourceยง

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Sourceยง

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Sourceยง

impl<T> Pointable for T

Sourceยง

const ALIGN: usize

The alignment of pointer.
Sourceยง

type Init = T

The type for initializers.
Sourceยง

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Sourceยง

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Sourceยง

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Sourceยง

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Sourceยง

impl<T> Same for T

Sourceยง

type Output = T

Should always be Self
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.
Sourceยง

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Sourceยง

fn vzip(self) -> V

Sourceยง

impl<T> WithSubscriber for T

Sourceยง

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
Sourceยง

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Sourceยง

fn is_within(&self, b: &G2) -> bool

Sourceยง

impl<T> ErasedDestructor for T
where T: 'static,

Sourceยง

impl<T> MaybeSendSync for T

Sourceยง

impl<T> ParallelSend for T
where T: Send,