Struct TarRegularFile 

pub struct TarRegularFile<'a, R> { /* private fields */ }

Regular-file metadata paired with a reader for its payload bytes.

Values of this type are yielded by TarReader and can also be built manually for TarWriter. The type implements AsyncRead so callers can stream file contents.

Implementations

impl<'a, R: AsyncRead + 'a> TarRegularFile<'a, R>

pub fn new<N: Into<Box<str>>>( path_name: N, size: u64, inner: R, ) -> TarRegularFile<'a, R>

Build a regular-file entry with the provided body reader.

size must match the exact number of bytes that inner will yield.

pub fn size(&self) -> u64

Return the size stored in the tar header.

pub fn path(&self) -> &str

Return the path stored for this entry.

pub fn mode(&self) -> u32

Return the raw permission bits stored in the tar header.

pub fn mtime(&self) -> SystemTime

Return the modification time stored for this entry.

pub fn atime(&self) -> Option<SystemTime>

Return the access time stored for this entry, if present.

pub fn ctime(&self) -> Option<SystemTime>

Return the status-change time stored for this entry, if present.

pub fn uid(&self) -> u32

Return the raw user id stored in the tar header.

pub fn uname(&self) -> &str

Return the symbolic user name stored in the tar header, if present.

pub fn with_uid(self, uid: u32) -> Self

Replace the raw user id stored in the tar header.

pub fn with_uname<S: Into<Box<str>>>(self, name: S) -> Self

Replace the symbolic user name stored in the tar header.

pub fn gid(&self) -> u32

Return the raw group id stored in the tar header.

pub fn gname(&self) -> &str

Return the symbolic group name stored in the tar header, if present.

pub fn with_gid(self, gid: u32) -> Self

Replace the raw group id stored in the tar header.

pub fn with_gname<S: Into<Box<str>>>(self, name: S) -> Self

Replace the symbolic group name stored in the tar header.

pub fn with_mode(self, mode: u32) -> Self

Replace the raw permission bits stored in the tar header.

pub fn with_mtime(self, mtime: SystemTime) -> Self

Replace the modification time stored for this entry.

pub fn with_atime(self, atime: SystemTime) -> Self

Replace the access time stored for this entry.

pub fn with_ctime(self, ctime: SystemTime) -> Self

Replace the status-change time stored for this entry.

pub fn attrs(&self) -> &AttrList

Return the extended attributes that will be encoded in PAX records.

pub fn attrs_mut(&mut self) -> &mut AttrList

Return a mutable reference to the extended attributes.

pub fn with_attrs(self, attrs: AttrList) -> Self

Replace the extended-attribute list and return the updated entry.

Trait Implementations

impl<'a, R: AsyncRead + 'a> AsyncRead for TarRegularFile<'a, R>

Available on crate feature smol only.

fn poll_read( self: Pin<&mut Self>, ctx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<'a, R: AsyncRead + 'a> From<TarRegularFile<'a, R>> for TarEntry<'a, R>

fn from(file: TarRegularFile<'a, R>) -> Self

Converts to this type from the input type.

impl<'__pin, 'a, R> Unpin for TarRegularFile<'a, R>

where PinnedFieldsOf<__Origin<'__pin, 'a, R>>: Unpin,