Struct Libc

Source

pub struct Libc;

Available on crate features unsafe_ffi only.

Expand description

🖥️ 🛠️ Raw C/POSIX system interfaces exposed through the platform’s libc.

^{📍 sys/os}

Thin, unsafe bindings that provide direct access to C ABI functions for memory mapping, shared memory, file descriptors, and other low-level operations. These are unmodified system calls as provided by the host libc.

https://www.gnu.org/software/libc/manual/html_node

Implementations§

Source §

impl Libc

Constants from POSIX and libc.

Source

pub const O_RDONLY: c_int = 0o0

POSIX open flag: open for read-only access.

Source

pub const O_WRONLY: c_int = 0o1

POSIX open flag: open for write-only access.

Source

pub const O_RDWR: c_int = 0o2

POSIX open flag: open for reading and writing.

Source

pub const O_CREAT: c_int = 0o100

POSIX open flag: create the file if it does not exist.

Source

pub const PROT_READ: c_int = 0x1

POSIX mmap protection: pages are readable.

Source

pub const PROT_WRITE: c_int = 0x2

POSIX mmap protection: pages are writable.

Source

pub const MAP_SHARED: c_int = 0x01

POSIX mmap flag: mapping is shared with other processes.

Source

pub const MAP_FAILED: *mut c_void

POSIX mmap failure sentinel returned on error.

Source

pub const MAP_PRIVATE: c_int = 0x02

POSIX mmap flag: mapping is private to this process.

Source

pub const MAP_ANONYMOUS: c_int = 0x20

Linux mmap flag: mapping is not backed by a file.

Source

pub const MAP_NORESERVE: c_int = 0x4000

Linux mmap flag: do not reserve swap space for this mapping.

Source §

impl Libc

Convenience helpers for libc return values.

Source

pub fn is_map_failed(ptr: *mut c_void) -> bool

Returns true if ptr matches the POSIX MAP_FAILED sentinel.

Source §

impl Libc

Direct wrappers around libc/POSIX calls.

Source

pub unsafe fn shm_open( name: *const c_char, oflag: c_int, mode: c_mode_t, ) -> c_int

Create/open POSIX shared memory.

https://www.man7.org/linux/man-pages/man3/shm_open.3.html

Source

pub unsafe fn shm_unlink(name: *const c_char) -> c_int

Unlink POSIX shared memory.

https://www.man7.org/linux/man-pages/man3/shm_open.3.html

Source

pub unsafe fn ftruncate(fd: c_int, length: c_off_t) -> c_int

Truncate a file to a specified length.

https://man7.org/linux/man-pages/man3/ftruncate.3p.html

Source

pub unsafe fn mmap( addr: mut c_void, length: usize, prot: c_int, flags: c_int, fd: c_int, offset: c_off_t, ) -> mut c_void

Map pages of memory.

https://man7.org/linux/man-pages/man3/mmap.3p.html

Source

pub unsafe fn munmap(addr: *mut c_void, length: usize) -> c_int

Unmap pages of memory.

https://man7.org/linux/man-pages/man3/munmap.3p.html

Source

pub unsafe fn free(ptr: *mut c_void)

Free allocated memory.

https://man7.org/linux/man-pages/man3/free.3p.html

Source

pub unsafe fn close(fd: c_int) -> c_int

Closes a file descriptor.

https://man7.org/linux/man-pages/man3/close.3p.html

Trait Implementations§

Source §

impl Debug for Libc

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for Libc

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> AnyExt for T
where T: Any + ?Sized,

Source §

fn type_id() -> TypeId

Returns the TypeId of Self. Read more

Source §

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more

Source §

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more

Source §

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more

Source §

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.

Source §

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.

Source §

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more

Source §

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more

Source §

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Available on crate feature alloc only.

Upcasts Box<self> as Box<dyn Any>. Read more

Source §

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout and non-crate feature safe_code only.

Returns some shared reference to the inner value if it is of type T. Read more

Source §

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout and non-crate feature safe_code only.

Returns some exclusive reference to the inner value if it is of type T. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> ByteSized for T

Source §

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.

Source §

const BYTE_SIZE: usize = _

The size of this type in bytes.

Source §

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.

Source §

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more

Source §

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Hook for T

Source §

fn hook<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Hooks a mutation step into the value and returns it. Read more

Source §

fn tap<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Taps into the value for observation and returns it unchanged. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> MemExt for T
where T: ?Sized,

Source §

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.

Source §

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more

Source §

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more

Source §

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more

Source §

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more

Source §

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more

Source §

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more

Source §

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more

Source §

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more

Source §

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more

Source §

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more

Source §

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more

Source §

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

Source §

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

Source §

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &[u8]. Read more

Source §

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &mut [u8]. Read more

Source §

impl<T, R> Morph<R> for T
where T: ?Sized,

Source §

fn morph<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Morphs the value into a new one and returns it. Read more

Source §

fn morph_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Morphs the value by shared reference and returns the result. Read more

Source §

fn morph_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Morphs the value by exclusive reference and returns the result. Read more

Source §

impl<T, U> TryFrom for T
where U: Into<T>,

Source §

type Error = Infallible

The type returned in the event of a conversion error.

Source §

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error> ⓘ

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error> ⓘ

Performs the conversion.

Struct Libc Copy item path

Implementations§

impl Libc

pub const O_RDONLY: c_int = 0o0

pub const O_WRONLY: c_int = 0o1

pub const O_RDWR: c_int = 0o2

pub const O_CREAT: c_int = 0o100

pub const PROT_READ: c_int = 0x1

pub const PROT_WRITE: c_int = 0x2

pub const MAP_SHARED: c_int = 0x01

pub const MAP_FAILED: *mut c_void

pub const MAP_PRIVATE: c_int = 0x02

pub const MAP_ANONYMOUS: c_int = 0x20

pub const MAP_NORESERVE: c_int = 0x4000

impl Libc

pub fn is_map_failed(ptr: *mut c_void) -> bool

impl Libc

pub unsafe fn shm_open( name: *const c_char, oflag: c_int, mode: c_mode_t, ) -> c_int

pub unsafe fn shm_unlink(name: *const c_char) -> c_int

pub unsafe fn ftruncate(fd: c_int, length: c_off_t) -> c_int

pub unsafe fn mmap( addr: *mut c_void, length: usize, prot: c_int, flags: c_int, fd: c_int, offset: c_off_t, ) -> *mut c_void

pub unsafe fn munmap(addr: *mut c_void, length: usize) -> c_int

pub unsafe fn free(ptr: *mut c_void)

pub unsafe fn close(fd: c_int) -> c_int

Trait Implementations§

impl Debug for Libc

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

Auto Trait Implementations§

impl Freeze for Libc

impl RefUnwindSafe for Libc

impl Send for Libc

impl Sync for Libc

impl Unpin for Libc

impl UnsafeUnpin for Libc

impl UnwindSafe for Libc

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> AnyExt for Twhere T: Any + ?Sized,

fn type_id() -> TypeId

fn type_of(&self) -> TypeId

fn type_name(&self) -> &'static str ⓘ

fn type_is<T: 'static>(&self) -> bool

fn type_hash(&self) -> u64

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

fn as_any_ref(&self) -> &dyn Anywhere Self: Sized,

fn as_any_mut(&mut self) -> &mut dyn Anywhere Self: Sized,

fn as_any_box(self: Box<Self>) -> Box<dyn Any>where Self: Sized,

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

const BYTE_SIZE: usize = _

fn byte_align(&self) -> usize

fn byte_size(&self) -> usize

fn ptr_size_ratio(&self) -> [usize; 2]

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Hook for T

fn hook<F>(self, f: F) -> Selfwhere F: FnOnce(&mut Self),

fn tap<F>(self, f: F) -> Selfwhere F: FnOnce(&Self),

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> MemExt for Twhere T: ?Sized,

const NEEDS_DROP: bool = _

fn mem_align_of<T>() -> usize

fn mem_align_of_val(&self) -> usize

fn mem_size_of<T>() -> usize

fn mem_size_of_val(&self) -> usize

fn mem_copy(&self) -> Selfwhere Self: Copy,

fn mem_needs_drop(&self) -> bool

fn mem_drop(self)where Self: Sized,

fn mem_forget(self)where Self: Sized,

fn mem_replace(&mut self, other: Self) -> Selfwhere Self: Sized,

fn mem_take(&mut self) -> Selfwhere Self: Default,

fn mem_swap(&mut self, other: &mut Self)where Self: Sized,

Struct Libc

pub unsafe fn mmap( addr: mut c_void, length: usize, prot: c_int, flags: c_int, fd: c_int, offset: c_off_t, ) -> mut c_void

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> AnyExt for T
where T: Any + ?Sized,

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn hook<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

fn tap<F>(self, f: F) -> Self
where F: FnOnce(&Self),

impl<T, U> Into<U> for T
where U: From<T>,

impl<T> MemExt for T
where T: ?Sized,

fn mem_copy(&self) -> Self
where Self: Copy,

fn mem_drop(self)
where Self: Sized,

fn mem_forget(self)
where Self: Sized,

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

fn mem_take(&mut self) -> Self
where Self: Default,

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

impl<T, R> Morph<R> for T
where T: ?Sized,

fn morph<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

fn morph_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

fn morph_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,