Enum nix::unistd::PathconfVar

#[non_exhaustive]
#[repr(i32)]
pub enum PathconfVar {
    LINK_MAX = 1,
    MAX_CANON = 2,
    MAX_INPUT = 3,
    MIN_HOLE_SIZE = 27,
    NAME_MAX = 4,
    PATH_MAX = 5,
    PIPE_BUF = 6,
    _POSIX_CHOWN_RESTRICTED = 7,
    _POSIX_NO_TRUNC = 8,
    _POSIX_VDISABLE = 9,
}

Available on crate features fs and feature only.

Variable names for pathconf

Nix uses the same naming convention for these variables as the getconf(1) utility. That is, PathconfVar variables have the same name as the abstract variables shown in the pathconf(2) man page. Usually, it’s the same as the C variable name without the leading _PC_.

POSIX 1003.1-2008 standardizes all of these variables, but some OSes choose not to implement variables that cannot change at runtime.

References

• pathconf(2)
• limits.h
• unistd.h

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

LINK_MAX = 1

Maximum number of links to a single file.

MAX_CANON = 2

Maximum number of bytes in a terminal canonical input line.

MAX_INPUT = 3

Minimum number of bytes for which space is available in a terminal input queue; therefore, the maximum number of bytes a conforming application may require to be typed as input before reading them.

MIN_HOLE_SIZE = 27

If a file system supports the reporting of holes (see lseek(2)), pathconf() and fpathconf() return a positive number that represents the minimum hole size returned in bytes. The offsets of holes returned will be aligned to this same value. A special value of 1 is returned if the file system does not specify the minimum hole size but still reports holes.

NAME_MAX = 4

Maximum number of bytes in a filename (not including the terminating null of a filename string).

PATH_MAX = 5

Maximum number of bytes the implementation will store as a pathname in a user-supplied buffer of unspecified size, including the terminating null character. Minimum number the implementation will accept as the maximum number of bytes in a pathname.

PIPE_BUF = 6

Maximum number of bytes that is guaranteed to be atomic when writing to a pipe.

_POSIX_CHOWN_RESTRICTED = 7

The use of chown and fchown is restricted to a process with appropriate privileges, and to changing the group ID of a file only to the effective group ID of the process or to one of its supplementary group IDs.

_POSIX_NO_TRUNC = 8

Pathname components longer than {NAME_MAX} generate an error.

_POSIX_VDISABLE = 9

This symbol shall be defined to be the value of a character that shall disable terminal special character handling.

Trait Implementations

impl Clone for PathconfVar

fn clone(&self) -> PathconfVar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathconfVar

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

Formats the value using the given formatter.

impl Hash for PathconfVar

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PathconfVar

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for PathconfVar

impl Eq for PathconfVar

impl StructuralPartialEq for PathconfVar