Skip to main content

PackageDocument

Struct PackageDocument 

Source
pub struct PackageDocument {
    pub minified: Option<String>,
    pub packages: BTreeMap<String, Vec<Map<String, Value>>>,
}
Expand description

A /p2/<vendor>/<name>.json document: a map (usually single-entry, keyed by vendor/name) of version lists. When minified is Some("composer/2.0"), the version lists are sparse diffs (see crate::minify); otherwise each entry stands alone.

Fields§

§minified: Option<String>

The minified-format marker. Some("composer/2.0") means the packages version lists are diffs; any other value (or None) means they stand alone.

§packages: BTreeMap<String, Vec<Map<String, Value>>>

vendor/name → version list (Packagist orders newest-first). Each version is a raw object so the minify/expand pass can run before any typed deserialization.

Implementations§

Source§

impl PackageDocument

Source

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

Parse a /p2/ document from JSON bytes.

Source

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

Serialize to compact JSON bytes.

Source

pub fn flat(packages: BTreeMap<String, Vec<Map<String, Value>>>) -> Self

Build a non-minified document: each version stands alone.

Source

pub fn minified(packages: BTreeMap<String, Vec<Map<String, Value>>>) -> Self

Build a minified composer/2.0 document from fully-materialized version lists, applying minify_versions to each package.

Source

pub fn expand(self) -> BTreeMap<String, Vec<Map<String, Value>>>

Expand into fully-materialized version objects, honoring the minified marker. A document whose marker is anything other than composer/2.0 is returned as-is (each entry already stands alone) — defensive against a future format bump.

Trait Implementations§

Source§

impl Clone for PackageDocument

Source§

fn clone(&self) -> PackageDocument

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 PackageDocument

Source§

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

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

impl Default for PackageDocument

Source§

fn default() -> PackageDocument

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

impl<'de> Deserialize<'de> for PackageDocument

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 PackageDocument

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.