Skip to main content

PublicCommand

Enum PublicCommand 

Source
pub enum PublicCommand {
    Summary {
        index_root: PathBuf,
        host: String,
        owner: String,
        repo: String,
        base_path: String,
        stale_after_hours: Option<i64>,
    },
    Profile {
        index_root: PathBuf,
        host: String,
        owner: String,
        repo: String,
        base_path: String,
        stale_after_hours: Option<i64>,
    },
    BatchProfiles {
        index_root: PathBuf,
        repos: Vec<String>,
        base_path: String,
        stale_after_hours: Option<i64>,
    },
    BatchQuery {
        index_root: PathBuf,
        repos: Vec<String>,
        paths: Vec<String>,
        base_path: String,
        stale_after_hours: Option<i64>,
    },
    Compare {
        index_root: PathBuf,
        repos: Vec<String>,
        base_path: String,
        stale_after_hours: Option<i64>,
    },
    Relations {
        index_root: PathBuf,
        host: String,
        owner: String,
        repo: String,
        base_path: String,
        stale_after_hours: Option<i64>,
    },
    Search {
Show 14 fields index_root: PathBuf, q: Option<String>, languages: Vec<String>, topics: Vec<String>, statuses: Vec<String>, confidences: Vec<String>, require_build: bool, require_test: bool, require_docs: bool, require_security_contact: bool, require_license: bool, limit: Option<usize>, base_path: String, stale_after_hours: Option<i64>,
}, Trust { index_root: PathBuf, host: String, owner: String, repo: String, base_path: String, stale_after_hours: Option<i64>, }, Query { index_root: PathBuf, host: String, owner: String, repo: String, path: String, base_path: String, stale_after_hours: Option<i64>, }, Export { index_root: PathBuf, out_dir: PathBuf, base_path: String, stale_after_hours: Option<i64>, generated_at: Option<String>, stale_after: Option<String>, pagedigest_previous: Option<PathBuf>, }, }

Variants§

§

Summary

Render one public repository summary response as JSON.

Fields

§index_root: PathBuf
§host: String
§owner: String
§repo: String
§base_path: String

URL base path prefix for hosted public links, such as /dotrepo.

§stale_after_hours: Option<i64>

Advisory staleness window in hours for the rendered response.

§

Profile

Render one compact public research profile response as JSON.

Fields

§index_root: PathBuf
§host: String
§owner: String
§repo: String
§base_path: String

URL base path prefix for hosted public links, such as /dotrepo.

§stale_after_hours: Option<i64>

Advisory staleness window in hours for the rendered response.

§

BatchProfiles

Render compact public research profiles for multiple repositories.

Fields

§index_root: PathBuf
§repos: Vec<String>

Repository identity as host/owner/repo or https://host/owner/repo.

§base_path: String

URL base path prefix for hosted public links, such as /dotrepo.

§stale_after_hours: Option<i64>

Advisory staleness window in hours for the rendered response.

§

BatchQuery

Render public query responses for multiple repositories and dot paths.

Fields

§index_root: PathBuf
§repos: Vec<String>

Repository identity as host/owner/repo or https://host/owner/repo.

§paths: Vec<String>

Dot path to query. Repeat for multiple fields.

§base_path: String

URL base path prefix for hosted public links, such as /dotrepo.

§stale_after_hours: Option<i64>

Advisory staleness window in hours for the rendered response.

§

Compare

Compare compact public research profiles for multiple repositories.

Fields

§index_root: PathBuf
§repos: Vec<String>

Repository identity as host/owner/repo or https://host/owner/repo.

§base_path: String

URL base path prefix for hosted public links, such as /dotrepo.

§stale_after_hours: Option<i64>

Advisory staleness window in hours for the rendered response.

§

Relations

Traverse public repository references declared in the selected profile.

Fields

§index_root: PathBuf
§host: String
§owner: String
§repo: String
§base_path: String

URL base path prefix for hosted public links, such as /dotrepo.

§stale_after_hours: Option<i64>

Advisory staleness window in hours for the rendered response.

§

Search

Search compact public research profiles by text and structured filters.

Fields

§index_root: PathBuf
§q: Option<String>

Text query matched against identity, name, purpose, homepage, license, languages, and topics.

§languages: Vec<String>

Required language. Repeat for multiple required languages.

§topics: Vec<String>

Required topic. Repeat for multiple required topics.

§statuses: Vec<String>

Required selected record status. Repeat for accepted statuses.

§confidences: Vec<String>

Required trust confidence. Repeat for accepted confidence values.

§require_build: bool

Require a build command signal.

§require_test: bool

Require a test command signal.

§require_docs: bool

Require documentation signal.

§require_security_contact: bool

Require security contact signal.

§require_license: bool

Require license signal.

§limit: Option<usize>

Maximum results to return.

§base_path: String

URL base path prefix for hosted public links, such as /dotrepo.

§stale_after_hours: Option<i64>

Advisory staleness window in hours for the rendered response.

§

Trust

Render one public trust response as JSON.

Fields

§index_root: PathBuf
§host: String
§owner: String
§repo: String
§base_path: String

URL base path prefix for hosted public links, such as /dotrepo.

§stale_after_hours: Option<i64>

Advisory staleness window in hours for the rendered response.

§

Query

Render one public query response as JSON.

Fields

§index_root: PathBuf
§host: String
§owner: String
§repo: String
§path: String
§base_path: String

URL base path prefix for hosted public links, such as /dotrepo.

§stale_after_hours: Option<i64>

Advisory staleness window in hours for the rendered response.

§

Export

Export the static-first public JSON tree for repository summary, profile, and trust.

Fields

§index_root: PathBuf
§out_dir: PathBuf
§base_path: String

URL base path prefix for hosted public links, such as /dotrepo.

§stale_after_hours: Option<i64>

Advisory staleness window in hours for exported responses.

§generated_at: Option<String>

Fixed RFC 3339 generation timestamp for deterministic export review.

§stale_after: Option<String>

Fixed RFC 3339 staleness timestamp for deterministic export review.

§pagedigest_previous: Option<PathBuf>

Previously published pagedigest manifest that carries revision state forward when exporting to a fresh directory. Defaults to .well-known/pagedigest.json inside –out-dir when present.

Trait Implementations§

Source§

impl FromArgMatches for PublicCommand

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for PublicCommand

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.