Skip to main content

RootManifest

Struct RootManifest 

Source
pub struct RootManifest {
    pub metadata_url: Option<String>,
    pub available_packages: Option<Vec<String>>,
    pub available_package_patterns: Option<Vec<String>>,
    pub providers_url: Option<String>,
    pub extra: Map<String, Value>,
}
Expand description

The root packages.json of a Composer v2 repository. Tells a client where to fetch per-package metadata (metadata_url, a template with a %package% placeholder) and, optionally, which packages exist. Unknown root keys round-trip through extra.

Fields§

§metadata_url: Option<String>

metadata-url — the per-package metadata template, e.g. https://repo.test/p2/%package%.json.

§available_packages: Option<Vec<String>>

available-packages — the full list of package names served.

§available_package_patterns: Option<Vec<String>>

available-package-patterns — wildcard patterns for served names.

§providers_url: Option<String>

providers-url — the legacy v1 provider template, if advertised.

§extra: Map<String, Value>

Any other root keys (e.g. notify-batch, search, mirrors, provider-includes), preserved verbatim on round-trip.

Implementations§

Source§

impl RootManifest

Source

pub fn metadata_template(base_url: &str) -> String

The v2 metadata-url template for a repository served at base_url: <base>/p2/%package%.json (trailing slash trimmed).

Source

pub fn v2(base_url: &str, available_packages: Vec<String>) -> Self

Build a minimal v2 root manifest: a metadata-url for base_url plus an available-packages list.

Source

pub fn parse(bytes: &[u8]) -> Result<Self, Error>

Parse a root packages.json from JSON bytes.

Source

pub fn to_vec(&self) -> Result<Vec<u8>, Error>

Serialize to compact JSON bytes.

Trait Implementations§

Source§

impl Clone for RootManifest

Source§

fn clone(&self) -> RootManifest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RootManifest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RootManifest

Source§

fn default() -> RootManifest

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for RootManifest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for RootManifest

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.