[]Struct lumol::sys::TrajectoryBuilder

pub struct TrajectoryBuilder<'a> { /* fields omitted */ }

A Trajectory builder, to set some options before opening a trajectory.

Examples

let trajectory = TrajectoryBuilder::new()
    .mode(OpenMode::Read)
    .open("file.xyz")
    .unwrap();

Methods

impl<'a> TrajectoryBuilder<'a>

pub fn new() -> TrajectoryBuilder<'a>

Create a new builder in read mode and with automatic format detection.

Examples

let trajectory = TrajectoryBuilder::new()
    .open("file.xyz")
    .unwrap();

pub fn format(self, format: &'a str) -> TrajectoryBuilder<'a>

Use a specific format when opening a file. See the chemfiles documentation for a format list.

Examples

let trajectory = TrajectoryBuilder::new()
    .format("PDB")
    .open("file.mol")
    .unwrap();

pub fn mode(self, mode: OpenMode) -> TrajectoryBuilder<'a>

Use a specific mode when opening a file.

Examples

let trajectory = TrajectoryBuilder::new()
    .mode(OpenMode::Write)
    .open("file.nc")
    .unwrap();

pub fn open<P>(self, path: P) -> Result<Trajectory, Error> where
    P: AsRef<Path>, 

Open the trajectory at the given path.

Examples

let trajectory = TrajectoryBuilder::new()
    .open("file.nc")
    .unwrap();

Auto Trait Implementations

impl<'a> Send for TrajectoryBuilder<'a>

impl<'a> Sync for TrajectoryBuilder<'a>

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

type Error = !

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

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

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

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]