Enum cap_primitives::fs::FollowSymlinks

pub enum FollowSymlinks {
    Yes,
    No,
}

Should symlinks be followed in the last component of a path?

This doesn’t affect path components other than the last. So for example in “foo/bar/baz”, if “foo” or “bar” are symlinks, they will always be followed. This enum value only determines whether “baz” is followed.

Instead of passing bare bools as parameters, pass a distinct enum so that the intent is clear.

Variants

Yes

Yes, do follow symlinks in the last component of a path.

No

No, do not follow symlinks in the last component of a path.

Implementations

impl FollowSymlinks

pub const fn follow(follow: bool) -> Self

Convert a bool where true means “follow” and false means “don’t follow” to a FollowSymlinks.

Trait Implementations

impl Clone for FollowSymlinks

fn clone(&self) -> FollowSymlinks

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FollowSymlinks

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

Formats the value using the given formatter.

impl PartialEq<FollowSymlinks> for FollowSymlinks

fn eq(&self, other: &FollowSymlinks) -> 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 FollowSymlinks

impl Eq for FollowSymlinks

impl StructuralEq for FollowSymlinks

impl StructuralPartialEq for FollowSymlinks