Struct ReadPathResponse 

#[non_exhaustive]
pub struct ReadPathResponse {
    pub entry: Option<FileEntry>,
    pub location: FileLocation,
    pub volume: String,
    pub entries: Vec<FileEntry>,
    pub entry_count: u32,
    pub next_entry_page_token: String,
    pub text: String,
    pub binary: bool,
    pub next_offset_bytes: u64,
    pub deploy_id: String,
}

What Client::read_path returns.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

entry: Option<FileEntry>

The path itself, symlinks followed; a symlink whose target does not exist is its own entry.

location: FileLocation

With service: where the path lies. Unspecified otherwise: the request says it.

volume: String

With service: the volume the path lies on, when location is VOLUME. Else empty.

entries: Vec<FileEntry>

A directory’s: directories first, then by name (bytewise).

entry_count: u32

A directory’s in all.

next_entry_page_token: String

Set = more entries follow these: pass it as entry_page_token.

text: String

A text file’s contents from offset_bytes, ending on a whole character. Untrusted.

binary: bool

True = the file is binary (a NUL byte in its first 8 KiB): no text. Download it with Client::create_transfer.

next_offset_bytes: u64

Where the next read of the file starts. 0 = the read reached its end.

deploy_id: String

The project’s files: the deploy whose files these are. Pass it as Client::deploy_project's base_deploy_id to be refused if they changed since you read them.

Trait Implementations

impl Clone for ReadPathResponse

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadPathResponse

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

Formats the value using the given formatter.

impl Default for ReadPathResponse

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReadPathResponse

From the API’s JSON. A field this version does not know is refused, as the API refuses one it does not have.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for ReadPathResponse

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ReadPathResponse

As the API’s JSON: the proto’s field names, an enum as its value’s name, a 64-bit integer as a string, a time as RFC 3339, bytes as base64.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReadPathResponse