Struct littlefs2::fs::OpenOptions [−][src]
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
[src]
pub unsafe fn open<'a, 'b, S: Storage>(
&self,
fs: &'b Filesystem<'a, S>,
alloc: &'b mut FileAllocation<S>,
path: &Path
) -> Result<File<'a, 'b, S>>
[src]
&self,
fs: &'b Filesystem<'a, S>,
alloc: &'b 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>
[src]
&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
[src]
pub fn read(&mut self, read: bool) -> &mut Self
[src]
pub fn write(&mut self, write: bool) -> &mut Self
[src]
pub fn append(&mut self, append: bool) -> &mut Self
[src]
pub fn create(&mut self, create: bool) -> &mut Self
[src]
pub fn create_new(&mut self, create_new: bool) -> &mut Self
[src]
pub fn truncate(&mut self, truncate: bool) -> &mut Self
[src]
Trait Implementations
impl Clone for OpenOptions
[src]
fn clone(&self) -> OpenOptions
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for OpenOptions
[src]
impl Default for OpenOptions
[src]
impl Eq for OpenOptions
[src]
impl PartialEq<OpenOptions> for OpenOptions
[src]
fn eq(&self, other: &OpenOptions) -> bool
[src]
fn ne(&self, other: &OpenOptions) -> bool
[src]
impl StructuralEq for OpenOptions
[src]
impl StructuralPartialEq for OpenOptions
[src]
Auto Trait Implementations
impl RefUnwindSafe for OpenOptions
impl Send for OpenOptions
impl Sync for OpenOptions
impl Unpin for OpenOptions
impl UnwindSafe for OpenOptions
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,