Struct OpenOptions

pub struct OpenOptions(/* private fields */);

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

This builder exposes the ability to configure how a File is opened and what operations are permitted on the open file. The File::open and File::create methods are aliases for commonly used options using this builder.

Consider File::with_options() to avoid having to use OpenOptions.

Implementations

impl OpenOptions

pub unsafe fn open<'a, 'b, S: Storage>( &self, fs: &'b Filesystem<'a, S>, alloc: &mut FileAllocation<S>, path: &Path, ) -> Result<File<'a, 'b, S>>

Open the file with the options previously specified, keeping references.

unsafe since UB can arise if files are not closed (see below).

The alternative method open_and_then is suggested.

Note that:

• files must be closed before going out of scope (they are stored in a linked list), closing removes them from there
• since littlefs is supposed to be fail-safe, we can’t just close files in Drop and panic if something went wrong.

pub fn open_and_then<'a, R, S: Storage>( &self, fs: &Filesystem<'a, S>, path: &Path, f: impl FnOnce(&File<'a, '_, S>) -> Result<R>, ) -> Result<R>

(Hopefully) safe abstraction around open.

pub fn new() -> Self

pub fn read(&mut self, read: bool) -> &mut Self

pub fn write(&mut self, write: bool) -> &mut Self

pub fn append(&mut self, append: bool) -> &mut Self

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

pub fn create_new(&mut self, create_new: bool) -> &mut Self

pub fn truncate(&mut self, truncate: bool) -> &mut Self

Trait Implementations

impl Clone for OpenOptions

fn clone(&self) -> OpenOptions

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenOptions

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

Formats the value using the given formatter.

impl Default for OpenOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<FileOpenFlags> for OpenOptions

fn from(flags: FileOpenFlags) -> Self

Converts to this type from the input type.

impl PartialEq for OpenOptions

fn eq(&self, other: &OpenOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for OpenOptions

impl StructuralPartialEq for OpenOptions