Struct Metadata 

pub struct Metadata { /* private fields */ }

Metadata information about an entry.

Examples

use libpna::{Duration, Metadata};

let since_unix_epoch = Duration::seconds(1000);
let metadata = Metadata::new()
    .with_accessed(Some(since_unix_epoch))
    .with_created(Some(since_unix_epoch))
    .with_modified(Some(since_unix_epoch));

Implementations

impl Metadata

pub const fn new() -> Metadata

Creates a new Metadata.

pub const fn with_created(self, created: Option<Duration>) -> Metadata

Sets the created time as the duration since the Unix epoch.

Examples

use libpna::{Duration, Metadata};

let since_unix_epoch = Duration::seconds(1000);
let metadata = Metadata::new().with_created(Some(since_unix_epoch));

pub const fn with_modified(self, modified: Option<Duration>) -> Metadata

Sets the modified time as the duration since the Unix epoch.

Examples

use libpna::{Duration, Metadata};

let since_unix_epoch = Duration::seconds(1000);
let metadata = Metadata::new().with_modified(Some(since_unix_epoch));

pub const fn with_accessed(self, accessed: Option<Duration>) -> Metadata

Sets the accessed time as the duration since the Unix epoch.

Examples

use libpna::{Duration, Metadata};

let since_unix_epoch = Duration::seconds(1000);
let metadata = Metadata::new().with_accessed(Some(since_unix_epoch));

pub fn with_permission(self, permission: Option<Permission>) -> Metadata

👎Deprecated since 0.34.0:

the fPRM chunk is superseded by the owner facet chunks; use Metadata::with_owner_uid/with_owner_gid/with_owner_user_name/with_owner_group_name/with_owner_user_sid/with_owner_group_sid/with_permission_mode

Sets the permission of the entry.

pub fn with_owner_uid(self, value: Option<OwnerUid>) -> Metadata

Sets the owner user id facet (fUId).

pub fn with_owner_gid(self, value: Option<OwnerGid>) -> Metadata

Sets the owner group id facet (fGId).

pub fn with_owner_user_name(self, value: Option<OwnerUserName>) -> Metadata

Sets the owner user name facet (fONm).

pub fn with_owner_group_name(self, value: Option<OwnerGroupName>) -> Metadata

Sets the owner group name facet (fGNm).

pub fn with_owner_user_sid(self, value: Option<OwnerUserSid>) -> Metadata

Sets the owner user SID facet (fOSi).

pub fn with_owner_group_sid(self, value: Option<OwnerGroupSid>) -> Metadata

Sets the owner group SID facet (fGSi).

pub fn with_permission_mode(self, value: Option<PermissionMode>) -> Metadata

Sets the POSIX permission mode facet (fMOd).

pub const fn with_link_target_type( self, link_target_type: Option<LinkTargetType>, ) -> Metadata

Sets the link target type of the entry. Only meaningful for symbolic link and hard link entries.

pub fn with_xattrs(self, xattrs: impl Into<Vec<ExtendedAttribute>>) -> Metadata

Sets the extended attributes facet (xATR).

Each attribute is serialized as one xATR chunk. Passing an empty collection records no attributes and emits no xATR chunks.

pub const fn raw_file_size(&self) -> Option<u128>

Returns the raw file size of this entry’s data in bytes.

pub const fn compressed_size(&self) -> usize

Returns the compressed size of this entry’s data in bytes.

pub const fn created(&self) -> Option<Duration>

Returns the created time since the Unix epoch for the entry.

pub const fn modified(&self) -> Option<Duration>

Returns the modified time since the Unix epoch for the entry.

pub const fn accessed(&self) -> Option<Duration>

Returns the accessed time since the Unix epoch for the entry.

pub const fn permission(&self) -> Option<&Permission>

👎Deprecated since 0.34.0:

the fPRM chunk is superseded by the owner facet chunks; use Metadata::owner_uid/owner_gid/owner_user_name/owner_group_name/owner_user_sid/owner_group_sid/permission_mode

Returns the owner, group, and permission bits for the entry.

pub const fn owner_uid(&self) -> Option<OwnerUid>

Returns the owner user id facet (fUId), if recorded.

pub const fn owner_gid(&self) -> Option<OwnerGid>

Returns the owner group id facet (fGId), if recorded.

pub fn owner_user_name(&self) -> Option<&OwnerUserName>

Returns the owner user name facet (fONm), if recorded.

pub fn owner_group_name(&self) -> Option<&OwnerGroupName>

Returns the owner group name facet (fGNm), if recorded.

pub fn owner_user_sid(&self) -> Option<&OwnerUserSid>

Returns the owner user SID facet (fOSi), if recorded.

pub fn owner_group_sid(&self) -> Option<&OwnerGroupSid>

Returns the owner group SID facet (fGSi), if recorded.

pub const fn permission_mode(&self) -> Option<PermissionMode>

Returns the POSIX permission mode facet (fMOd), if recorded.

pub const fn link_target_type(&self) -> Option<LinkTargetType>

Returns the link target type for this entry, if present.

• None: fLTP chunk was absent.
• Some(Unknown): fLTP chunk present but target type undetermined.
• Some(File) / Some(Directory): known target type.

pub fn xattrs(&self) -> &[ExtendedAttribute]

Returns the extended attributes (xATR) recorded for this entry.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Default for Metadata

fn default() -> Metadata

Returns the “default value” for a type.

impl Eq for Metadata

impl Hash for Metadata

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

where __H: Hasher,

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 MetadataFsExt for Metadata

fn from_metadata(metadata: &Metadata) -> Result<Self>

where Self: Sized,

Creates a new Metadata from the given fs::Metadata.

Examples

use pna::{Metadata, prelude::*};
use std::fs;

Metadata::from_metadata(&fs::metadata("path/to/file")?)?;
Ok(())

Errors

Currently never returns an error.

impl MetadataPathExt for Metadata

fn from_path<P: AsRef<Path>>(path: P) -> Result<Self>

where Self: Sized,

Creates a new Metadata from the given path.

Examples

use pna::{Metadata, prelude::*};

Metadata::from_path("path/to/file");

Errors

Returns an error if std::fs::metadata returns an error.

fn from_symlink_path<P: AsRef<Path>>(path: P) -> Result<Self>

where Self: Sized,

Creates a new Metadata from the given path without following symlinks.

Examples

use pna::{Metadata, prelude::*};

Metadata::from_symlink_path("path/to/file");

Errors

Returns an error if std::fs::symlink_metadata returns an error.

impl MetadataTimeExt for Metadata

fn created_time(&self) -> Option<SystemTime>

👎Deprecated since 0.34.0:

panics for archive timestamps outside the platform’s SystemTime range; use try_created_time or saturating_created_time

Returns the created time.

This is the same as Metadata::created + SystemTime::UNIX_EPOCH.

use pna::{Duration, Metadata, prelude::*};
use std::time::UNIX_EPOCH;

let metadata = Metadata::new().with_created(Some(Duration::seconds(1000)));

assert_eq!(
    metadata.created().map(|d| UNIX_EPOCH + d),
    metadata.created_time(),
);

fn modified_time(&self) -> Option<SystemTime>

👎Deprecated since 0.34.0:

panics for archive timestamps outside the platform’s SystemTime range; use try_modified_time or saturating_modified_time

Returns the modified time.

This is the same as Metadata::modified + SystemTime::UNIX_EPOCH.

use pna::{Duration, Metadata, prelude::*};
use std::time::UNIX_EPOCH;

let metadata = Metadata::new().with_modified(Some(Duration::seconds(1000)));

assert_eq!(
    metadata.modified().map(|d| UNIX_EPOCH + d),
    metadata.modified_time(),
);

fn accessed_time(&self) -> Option<SystemTime>

👎Deprecated since 0.34.0:

panics for archive timestamps outside the platform’s SystemTime range; use try_accessed_time or saturating_accessed_time

Returns the accessed time.

This is the same as Metadata::accessed + SystemTime::UNIX_EPOCH.

use pna::{Duration, Metadata, prelude::*};
use std::time::UNIX_EPOCH;

let metadata = Metadata::new().with_accessed(Some(Duration::seconds(1000)));

assert_eq!(
    metadata.accessed().map(|d| UNIX_EPOCH + d),
    metadata.accessed_time(),
);

fn with_created_time(self, time: impl Into<Option<SystemTime>>) -> Self

Sets the created time.

Examples

use pna::{Metadata, prelude::*};
use std::time::{Duration, SystemTime, UNIX_EPOCH};

// Time after Unix epoch will be preserved
let after_epoch = UNIX_EPOCH + Duration::from_secs(1000);
let metadata = Metadata::new().with_created_time(Some(after_epoch));
assert_eq!(metadata.created_time(), Some(after_epoch));

let before_epoch = UNIX_EPOCH - Duration::from_secs(1);
let metadata = Metadata::new().with_created_time(Some(before_epoch));
assert_eq!(metadata.created_time(), Some(before_epoch));

fn with_modified_time(self, time: impl Into<Option<SystemTime>>) -> Self

Sets the modified time.

Examples

use pna::{Metadata, prelude::*};
use std::time::{Duration, SystemTime, UNIX_EPOCH};

// Time after Unix epoch will be preserved
let after_epoch = UNIX_EPOCH + Duration::from_secs(1000);
let metadata = Metadata::new().with_modified_time(Some(after_epoch));
assert_eq!(metadata.modified_time(), Some(after_epoch));

let before_epoch = UNIX_EPOCH - Duration::from_secs(1);
let metadata = Metadata::new().with_modified_time(Some(before_epoch));
assert_eq!(metadata.modified_time(), Some(before_epoch));

fn with_accessed_time(self, time: impl Into<Option<SystemTime>>) -> Self

Sets the accessed time.

Examples

use pna::{Metadata, prelude::*};
use std::time::{Duration, SystemTime, UNIX_EPOCH};

// Time after Unix epoch will be preserved
let after_epoch = UNIX_EPOCH + Duration::from_secs(1000);
let metadata = Metadata::new().with_accessed_time(Some(after_epoch));
assert_eq!(metadata.accessed_time(), Some(after_epoch));

let before_epoch = UNIX_EPOCH - Duration::from_secs(1);
let metadata = Metadata::new().with_accessed_time(Some(before_epoch));
assert_eq!(metadata.accessed_time(), Some(before_epoch));

fn try_created_time(&self) -> Result<Option<SystemTime>, SystemTimeOutOfRange>

Returns the created time, or Err if the stored duration is outside the platform’s representable SystemTime range.

fn try_modified_time(&self) -> Result<Option<SystemTime>, SystemTimeOutOfRange>

Returns the modified time, or Err if the stored duration is outside the platform’s representable SystemTime range.

fn try_accessed_time(&self) -> Result<Option<SystemTime>, SystemTimeOutOfRange>

Returns the accessed time, or Err if the stored duration is outside the platform’s representable SystemTime range.

fn saturating_created_time(&self) -> Option<SystemTime>

Returns the created time, clamping an out-of-range stored duration to the platform’s representable bound.

fn saturating_modified_time(&self) -> Option<SystemTime>

Returns the modified time, clamping an out-of-range stored duration to the platform’s representable bound.

fn saturating_accessed_time(&self) -> Option<SystemTime>

Returns the accessed time, clamping an out-of-range stored duration to the platform’s representable bound.

impl Ord for Metadata

fn cmp(&self, other: &Metadata) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Metadata

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Metadata

fn partial_cmp(&self, other: &Metadata) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Metadata