Struct oceanpkg::drop::manifest::Manifest

pub struct Manifest {
    pub meta: Meta,
    pub deps: Option<Deps>,
}

A drop manifest.

Note the lack of drop::Name usage throughout this type. This is because name validation is done by the backend in order for clients to be forward-compatible with later backend versions.

Fields

meta: Meta

The drop's info.

deps: Option<Deps>

The drops that this drop relies on.

Methods

impl Manifest

pub const FILE_NAME: &'static str

The name used for manifest files.

pub fn parse_json(json: &str) -> Result<Self, Error>

Parses a manifest from JSON.

use oceanpkg::drop::Manifest;

let json = r#"{
    "meta": {
        "name": "ocean",
        "description": "Cross-platform package manager",
        "version": "0.1.0",
        "license": "AGPL-3.0-only",
        "authors": ["Nikolai Vazquez", "Alex Farra", "Nicole Zhao"],
        "readme": "README.md",
        "changelog": "CHANGELOG.md",
        "git": "https://github.com/oceanpkg/ocean"
    },
    "dependencies": {
        "wget": "*"
    }
}"#;
let manifest = Manifest::parse_json(json).unwrap();

pub fn read_json<J>(json: J) -> Result<Self, Error> where
    J: Read, 

Parses a manifest from JSON provided by the reader.

pub fn read_json_file<J>(json: J) -> Result<Self, Error> where
    J: AsRef<Path>, 

Parses a manifest from a JSON file at the given path.

pub fn to_json(&self, pretty: bool) -> Result<String, Error>

Returns self as a JSON string.

pub fn files(&self) -> Vec<&str>

Returns the list of files to package.

Trait Implementations

impl Clone for Manifest

fn clone(&self) -> Manifest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Manifest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Manifest

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

Deserialize this value from the given Serde deserializer.

impl Eq for Manifest

impl Hash for Manifest

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Manifest> for Manifest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Manifest

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Manifest

impl StructuralPartialEq for Manifest