Skip to main content
← rust.krizaka.comkrizaka.com

ScopedPath

Struct ScopedPath 

Source
pub struct ScopedPath(/* private fields */);
Expand description

A path the scope let through: canonical, inside a granted folder (or a file dropped this session), not sensitive.

Only ScopeStore::resolve and crate::access::Access::resolve make one, so a function that takes a ScopedPath can never be handed a path the scope did not see. A read goes through ScopedPath::open, which confirms that the opened file is still this one.

use krizaka_rust::scope::ScopeStore;
let dir = tempfile::tempdir()?;
let home = dir.path().canonicalize()?;
std::fs::create_dir(home.join("docs"))?;
std::fs::write(home.join("docs/a.txt"), "hello")?;
let mut scope = ScopeStore::default();
scope.grant_with_home(&home.join("docs"), Some(&home))?;
let file = scope.resolve_with_home(&home.join("docs/a.txt"), Some(&home))?;
assert_eq!(krizaka_rust::files::preview(&file, &Default::default())?.text.as_deref(), Some("hello"));

It cannot be made from a bare path:

ⓘ
let _ = krizaka_rust::scope::ScopedPath(std::path::PathBuf::from("/etc/hosts"));

Implementations§

Source§

impl ScopedPath

Source

pub fn as_path(&self) -> &Path

Source

pub fn into_path_buf(self) -> PathBuf

Source

pub fn open(&self) -> Result<File, ScopeError>

Opens the file once, read only, and confirms the descriptor is the file the scope let through.

The path may have changed since it was resolved: the file, or one of its parent folders, swapped for a link out of the grant. The last component is opened without following a link, and the system is asked where the opened file really is; anything but the resolved path is refused. Read the metadata and the content from the returned file, never from the path again.

Trait Implementations§

Source§

impl AsRef<Path> for ScopedPath

Source§

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for ScopedPath

Source§

fn clone(&self) -> Self

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 ScopedPath

Source§

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

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

impl Eq for ScopedPath

Source§

impl Hash for ScopedPath

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ScopedPath

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ScopedPath

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.