Enum XattrFiltering 

#[non_exhaustive]
pub enum XattrFiltering {
    AllowlistOnly,
    KeepUserXattrs,
}

Controls which extended attributes FileSystem::transform_for_oci keeps when processing a filesystem for OCI container image consistency.

Implements std::str::FromStr/std::fmt::Display by hand using kebab-case names (allowlist-only, keep-user-xattrs) so it can be used directly as a CLI value (e.g. via clap::value_parser!(XattrFiltering)), and exposes Self::VARIANTS to enumerate every mode in preference order (default first) — useful for callers that need to find which mode produces a given digest. Behind the varlink feature it additionally derives Serialize/Deserialize and zlink_core::introspect::Type, so it can be used as-is as a varlink wire parameter; there it serializes as the bare Rust variant name (e.g. "AllowlistOnly"), matching its introspected interface schema.

This is hand-rolled rather than derived (e.g. via strum) since there are currently only two variants; if this grows a handful more, revisit pulling in a derive crate.

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.

AllowlistOnly

Unconditionally strip all xattrs except CONTAINER_XATTR_ALLOWLIST.

This is the historical default. It can cause composefs digest mismatches when legitimate user.* xattrs present in an image are stripped by one composefs-rs version but not another.

KeepUserXattrs

Keep CONTAINER_XATTR_ALLOWLIST xattrs and user.* extended attributes.

Use this when the source of the filesystem is known to only ever contain legitimate user.* xattrs (i.e. not host-leaked xattrs from a mounted overlayfs), so that they can be preserved across digest recomputation.

Implementations

impl XattrFiltering

pub const VARIANTS: &'static [XattrFiltering]

All variants, in preference order (default first).

Hand-maintained since this type is #[non_exhaustive]: add new variants here (and to the Display/FromStr impls below) when extending this enum.

Trait Implementations

impl Clone for XattrFiltering

fn clone(&self) -> XattrFiltering

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for XattrFiltering

impl Debug for XattrFiltering

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

Formats the value using the given formatter.

impl Default for XattrFiltering

fn default() -> XattrFiltering

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for XattrFiltering

fn deserialize<__D>( __deserializer: __D, ) -> Result<XattrFiltering, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for XattrFiltering

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

Formats the value using the given formatter.

impl Eq for XattrFiltering

impl FromStr for XattrFiltering

type Err = XattrFilteringParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<XattrFiltering, <XattrFiltering as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for XattrFiltering

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for XattrFiltering

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for XattrFiltering

impl Type for XattrFiltering

const TYPE: &'static Type<'static>

The type information.