Struct Classpath

pub struct Classpath { /* private fields */ }

A classpath in java

Implementations

impl Classpath

pub fn new() -> Self

Creates an empty classpath

pub fn is_empty(&self) -> bool

Checks if the given classpath is empty

pub fn len(&self) -> usize

Gets the number of entries in the classpath

pub fn as_os_string(&self) -> OsString

Converts this classpath into a usable classpath for java

Example

let cp = Classpath::from_iter(["file1", "file2", "file3"]);
assert_eq!(cp.as_os_string(), OsString::from(format!("file1{0}file2{0}file3", CLASSPATH_SEPARATOR)));

pub fn get<P: AsRef<str>>(&self, path: P) -> Option<Result<Resource>>

Attempts to get a resource on the classpath.

Paths will be interpreted with only / as a separator. A leading / is ignored.

Return

Will return None is path is not on classpath. Otherwise, Some(Result) is returned where the resource exists. The result is Ok if the inner is actually readable.

Example

let cp = Classpath::from_str("run.jar");
let resource = cp.get("META-INF/MANIFEST").expect("manifest not found");

impl Classpath

Classpath manipulation methods

pub fn push_front<P: AsRef<Path>>(&mut self, path: P)

Pushes a new entry to this classpath, at the front.

pub fn push_back<P: AsRef<Path>>(&mut self, path: P)

Pushes a new entry to this classpath, at the back.

pub fn join(self, other: Self) -> Self

Joins two classpaths together, with the self classpath being at the front and the other classpath at the back.

Trait Implementations

impl Add for Classpath

type Output = Classpath

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Classpath

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Classpath

fn clone(&self) -> Classpath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Classpath

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

Formats the value using the given formatter.

impl Default for Classpath

fn default() -> Classpath

Returns the “default value” for a type.

impl Display for Classpath

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

Formats the value using the given formatter.

impl<P: AsRef<Path>> Extend<P> for Classpath

fn extend<T: IntoIterator<Item = P>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<&OsStr> for Classpath

fn from(path: &OsStr) -> Self

Tries to create a classpath where the given path is a single entry.

impl From<&Path> for Classpath

fn from(path: &Path) -> Self

Tries to create a classpath where the given path is a single entry.

impl From<&str> for Classpath

fn from(path: &str) -> Self

Tries to create a classpath where the given path is a single entry.

impl From<PathBuf> for Classpath

fn from(path: PathBuf) -> Self

Tries to create a classpath where the given path is a single entry.

impl From<Vec<PathBuf>> for Classpath

fn from(vec: Vec<PathBuf>) -> Self

Converts to this type from the input type.

impl<P> FromIterator<P> for Classpath

where P: AsRef<Path>,

fn from_iter<T: IntoIterator<Item = P>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for Classpath

fn from_str(s: &str) -> Result<Self, Self::Err>

Attempts to parse a classpath, with entries seperated by the Os’s classpath separator

type Err = Infallible

The associated error which can be returned from parsing.

impl Hash for Classpath

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterator for &'a Classpath

type Item = &'a Path

The type of the elements being iterated over.

type IntoIter = IntoIter<&'a Path>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Classpath

type Item = PathBuf

The type of the elements being iterated over.

type IntoIter = IntoIter<PathBuf>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Classpath

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Classpath

impl StructuralPartialEq for Classpath