oceanpkg 0.0.11

Client library for the Ocean package manager.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

use std::{
    path::PathBuf,
    process::Command,
};
use crate::{
    drop::{
        Metadata,
        name::Query,
    },
    install::InstallTarget,
};

/// A package that can be executed; e.g. CLI tool or script.
#[derive(Clone, Debug)]
pub struct Exe {
    metadata: Metadata,
    bin_name: String,
}

impl Exe {
    /// Returns an executable matching `query`, installed for `target`.
    pub fn installed<S: AsRef<str>>(
        query: &Query<S>,
        target: &InstallTarget,
    ) -> Result<Self, ()> {
        let query = query.to_ref::<str>();
        unimplemented!("TODO: Find installation of {:?} for {:?}", query, target)
    }

    /// Returns basic metadata for the drop.
    #[inline]
    pub const fn metadata(&self) -> &Metadata {
        &self.metadata
    }

    /// Returns the name of the binary executable.
    #[inline]
    pub fn bin_name(&self) -> &str {
        &self.bin_name
    }

    /// Returns the path of the drop's executable binary, if one exists.
    pub fn bin_path<'t>(
        &self,
        target: &'t InstallTarget,
    ) -> Result<PathBuf, FindError<'t>> {
        unimplemented!(
            "TODO: Find {:?} binary for {:?}",
            self.metadata.name,
            target,
        )
    }

    /// Returns a `Command` instance suitable for running the drop's executable
    /// binary, if one exists.
    pub fn command<'t>(
        &self,
        target: &'t InstallTarget
    ) -> Result<Command, FindError<'t>> {
        self.bin_path(target).map(Command::new)
    }
}

/// An error returned when the binary for an executable drop cannot be found.
#[derive(Debug)]
pub struct FindError<'a> {
    target: &'a InstallTarget,
}