Skip to main content

FsContentProvider

Struct FsContentProvider 

Source
pub struct FsContentProvider { /* private fields */ }
Expand description

Filesystem-backed ContentProvider for the build-time pipeline.

Resolves keys relative to a configured root directory. This is the default adapter used by ssg build and is intentionally a thin wrapper around std::fs::read so the existing batch pipeline keeps its byte-identical behaviour (AC9).

§Examples

use ssg_core::{ContentProvider, FsContentProvider};

let dir = tempfile::tempdir().unwrap();
std::fs::write(dir.path().join("a.md"), b"# A").unwrap();
let fs = FsContentProvider::new(dir.path());
assert_eq!(fs.fetch("a.md").unwrap(), b"# A");

Implementations§

Source§

impl FsContentProvider

Source

pub fn new<P: Into<PathBuf>>(root: P) -> Self

Constructs an FsContentProvider rooted at root.

root is typically the site directory — every fetched key is resolved as root.join(key).

§Examples
use ssg_core::FsContentProvider;

let dir = tempfile::tempdir().unwrap();
let fs = FsContentProvider::new(dir.path());
assert_eq!(fs.root(), dir.path());
Source

pub fn root(&self) -> &Path

Returns the configured root directory.

§Examples
use ssg_core::FsContentProvider;
use std::path::Path;

let fs = FsContentProvider::new("/tmp/site");
assert_eq!(fs.root(), Path::new("/tmp/site"));

Trait Implementations§

Source§

impl Clone for FsContentProvider

Source§

fn clone(&self) -> FsContentProvider

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 ContentProvider for FsContentProvider

Source§

fn fetch(&self, key: &str) -> ProviderResult<Vec<u8>>

Fetches the raw bytes for key, or returns an error. Read more
Source§

fn contains(&self, key: &str) -> bool

Reports whether key exists without materialising the bytes. Read more
Source§

fn fetch_string(&self, key: &str) -> ProviderResult<String>

Convenience: fetches key and decodes as UTF-8. Read more
Source§

impl Debug for FsContentProvider

Source§

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

Formats the value using the given formatter. 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> 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> Same for T

Source§

type Output = T

Should always be Self
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.