Enum monotron_api::OpenMode

#[repr(C)]
pub enum OpenMode {
    ReadOnly {
        non_blocking: bool,
    },
    WriteOnly {
        append: bool,
        create: bool,
        exclusive: bool,
        truncate: bool,
        non_blocking: bool,
    },
    ReadWrite {
        append: bool,
        create: bool,
        exclusive: bool,
        truncate: bool,
        non_blocking: bool,
    },
}

The ways in which we can open a file.

TODO: Replace all these booleans with a u8 flag-set

Variants

ReadOnly

Open file in read-only mode. No writes allowed. One file can be opened in read-only mode multiple times.

Fields of ReadOnly

non_blocking: bool

Set to true if read/write requests on this handle should be non-blocking

WriteOnly

Open a file for writing, but not reading.

Fields of WriteOnly

append: bool

If true, the write pointer will default to the end of the file

create: bool

If true, the file will be created if it doesn't exist. If false, the file must exist. See also the exclusive flag.

exclusive: bool

If true AND the create flag is true, the open will fail if the file already exists.

truncate: bool

If true, the file contents will be deleted on open, giving a zero byte file.

non_blocking: bool

Set to true if read/write requests on this handle should be non-blocking

ReadWrite

Open a file for reading and writing.

Fields of ReadWrite

append: bool

If true, the write pointer will default to the end of the file

create: bool

If true, the file will be created if it doesn't exist. If false, the file must exist. See also the exclusive flag.

exclusive: bool

If true AND the create flag is true, the open will fail if the file already exists.

truncate: bool

If true, the file contents will be deleted on open, giving a zero byte file.

non_blocking: bool

Set to true if read/write requests on this handle should be non-blocking