Struct pachyderm::pfs::ListFileRequest

pub struct ListFileRequest {
    pub file: Option<File>,
    pub full: bool,
    pub history: i64,
}

Fields

file: Option<File>

File is the parent directory of the files we want to list. This sets the repo, the commit/branch, and path prefix of files we're interested in If the "path" field is omitted, a list of files at the top level of the repo is returned

full: bool

Full indicates whether the result should include file contents, which may be large (i.e. the list of children for directories, and the list of object references for regular files)

history: i64

History indicates how many historical versions you want returned. Its semantics are: 0: Return the files as they are at the commit in file. FileInfo.File will equal File in this request. 1: Return the files as they are in the last commit they were modified in. (This will have the same hash as if you'd passed 0, but FileInfo.File.Commit will be different. 2: Return the above and the files as they are in the next-last commit they were modified in. 3: etc. -1: Return all historical versions.

Trait Implementations

impl Clone for ListFileRequest

fn clone(&self) -> ListFileRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListFileRequest

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

Formats the value using the given formatter.

impl Default for ListFileRequest

fn default() -> ListFileRequest

Returns the "default value" for a type.

impl Message for ListFileRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<ListFileRequest> for ListFileRequest

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

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

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

This method tests for !=.

impl StructuralPartialEq for ListFileRequest