Struct memfile::CreateOptions

pub struct CreateOptions { /* fields omitted */ }

Options for creating a MemFile.

Support for options depend on platform and OS details. Refer to your OS documentation for memfd_create for more information.

Implementations

impl CreateOptions

pub fn new() -> Self

Get the default creation options for a MemFile.

Initially, file sealing is not enabled no no huge TLB page size is configured.

Note that the close-on-exec flag will always be set on the created file descriptor. If you want to pass it to a child process, you should use libc::dup2 or something similar after forking. Disabling the close-on-exec flag before forking causes a race condition with other threads.

pub fn create(&self, name: &str) -> Result<MemFile>

Create a new MemFile` with the current options.

This is a shorthand for MemFile::create. See that function for more details.

pub fn create_cstr(&self, name: &CStr) -> Result<MemFile>

Create a new MemFile` with the current options.

This is identical to Self::create, except that it takes the name as CStr to avoid allocations. See MemFile::create for more details.

pub fn allow_sealing(self, value: bool) -> Self

Allow sealing operations on the created MemFile.

pub fn huge_tlb(self, value: impl Into<Option<HugeTlb>>) -> Self

Create the file in a hugetlbfs filesystem using huge pages for the translation look-aside buffer.

Support for this feature and specific sizes depend on the CPU and kernel configuration. See also: https://www.kernel.org/doc/html/latest/admin-guide/mm/hugetlbpage.html

Trait Implementations

impl Clone for CreateOptions

fn clone(&self) -> CreateOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateOptions

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

Formats the value using the given formatter.

impl Default for CreateOptions

fn default() -> CreateOptions

Returns the “default value” for a type.

impl Copy for CreateOptions