Struct OpenOptions 

pub struct OpenOptions { /* private fields */ }

Options and flags which can be used to configure how a Galaxy is opened.

This builder exposes the ability to configure how a Galaxy is opened and what permissions on the opened galaxy, or more exactly, the graphs it manages.

Generally speaking, when using Options, you’ll first call OpenOptions::new, then chain calls to methods to set each option, then call OpenOptions::open to open a galaxy. This will give a crate::Result with a Galaxy inside that you can further operate on.

Examples

use tugraph::{db::OpenOptions, Error};
let galaxy = OpenOptions::new()
    .create(true)
    .open("/tmp/rust_tugraph/doc/OpenOptions", "admin", "73@TuGraph")?;

Implementations

impl OpenOptions

pub fn new() -> Self

Creates a initial new set of options with dir where the database was created or to be created, the username and password used to open if exists.

All other options not listed in parameters are default to false.

Errors

TODO(eadrenking@outlook.com)

Examples

use tugraph::{db::OpenOptions, Error};
let galaxy = OpenOptions::new()
    .create(true)
    .open("/tmp/rust_tugraph/doc/open_new", "admin", "73@TuGraph")?;

pub fn durable(self, durable: bool) -> Self

Whether the read-write transaction commited into database should be durable.

Errors

TODO(eadrenking@outlook.com)

Examples

use tugraph::{db::OpenOptions, Error};
let galaxy = OpenOptions::new()
    .create(true)
    .durable(true)
    .open("/tmp/rust_tugraph/doc/open_durable", "admin", "73@TuGraph")?;

pub fn create(self, create: bool) -> Self

Whether the read-write transaction commited into database should be durable.

Errors

TODO(eadrenking@outlook.com)

Examples

use tugraph::{db::OpenOptions, Error};
let galaxy = OpenOptions::new()
    .create(true)
    .durable(true)
    .open("/tmp/rust_tugraph/doc/open_create", "admin", "73@TuGraph")?;

pub fn open<P: AsRef<Path>>( self, dir: P, username: &str, password: &str, ) -> Result<Galaxy>

Open a Galaxy with options specified by self.

Errors

TODO(eadrenking@outlook.com)

Examples

use tugraph::{db::OpenOptions, Error};
let galaxy = OpenOptions::new()
    .create(true)
    .durable(true)
    .open("/tmp/rust_tugraph/doc/open", "admin", "73@TuGraph")?;

Trait Implementations

impl Default for OpenOptions

fn default() -> OpenOptions

Returns the “default value” for a type.