Struct ListRefsOptions 

pub struct ListRefsOptions {
    pub prefixes: Vec<String>,
    pub heads: bool,
    pub tags: bool,
    pub symrefs: bool,
    pub peel: bool,
    pub protocol_version: Option<u8>,
    pub sort: RefSort,
    pub limit: Option<usize>,
    pub versionsort_suffixes: Vec<String>,
}

Options controlling Remote::list_refs output, aligned with git ls-remote.

Fields

prefixes: Vec<String>

If non-empty, only refs matching one of these patterns (same rules as git ls-remote).

heads: bool

Restrict to refs/heads/ entries.

tags: bool

Restrict to refs/tags/ entries.

symrefs: bool

Include symbolic-ref targets on HEAD (and all symrefs on v2 when supported).

peel: bool

Append peeled ^{} lines for annotated tags.

protocol_version: Option<u8>

Requested wire protocol version for remote listing (None → prefer v2).

sort: RefSort

Sort key and direction (after filtering; matches git ls-remote --sort).

limit: Option<usize>

Maximum number of lines to return after sorting (None = unlimited).

versionsort_suffixes: Vec<String>

versionsort.suffix values for SortKey::Version (Git multi-valued config).

Trait Implementations

impl Clone for ListRefsOptions

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 ListRefsOptions

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

Formats the value using the given formatter.

impl Default for ListRefsOptions

fn default() -> Self

Returns the “default value” for a type.