Struct LocalArchive

pub struct LocalArchive {
    pub(super) data: RepositoryData,
    pub(super) out_path: Arc<Path>,
    pub(super) ignore: IgnoreSource,
    pub(super) file_state: RwLock<SourceDir>,
    pub(super) is_managed: OnceLock<Option<GitUrl>>,
}

Fields

data: RepositoryData

out_path: Arc<Path>

ignore: IgnoreSource

file_state: RwLock<SourceDir>

is_managed: OnceLock<Option<GitUrl>>

Available on crate feature gitlab only.

Implementations

impl LocalArchive

pub fn out_dir_of(p: &Path) -> PathBuf

pub async fn unzip_from_remote( id: ArchiveId, url: &str, cont: impl FnMut(&Path), ) -> Result<(), ()>

Available on crate feature zip only.

Errors

pub fn zip(&self) -> impl Stream<Item = Result<Bytes>>

Available on crate feature zip only.

pub fn is_managed(&self) -> Option<&GitUrl>

Available on crate feature gitlab only.

pub fn source_dir_of(p: &Path) -> PathBuf

pub fn path(&self) -> &Path

pub fn file_state(&self) -> FileStates

pub fn state_summary(&self) -> FileStateSummary

pub fn out_dir(&self) -> &Path

pub fn source_dir(&self) -> PathBuf

pub fn is_meta(&self) -> bool

pub fn uri(&self) -> ArchiveURIRef<'_>

pub fn id(&self) -> &ArchiveId

pub fn formats(&self) -> &[SourceFormatId]

pub const fn attributes(&self) -> &VecMap<Box<str>, Box<str>>

pub const fn dependencies(&self) -> &[ArchiveId]

pub fn with_sources<R>(&self, f: impl FnOnce(&SourceDir) -> R) -> R

pub(crate) fn update_sources(&self, sender: &ChangeSender<BackendChange>)

fn load_module( &self, path: Option<&Name>, name: &NameStep, ) -> Option<OpenModule<Unchecked>>

fn submit_triples( &self, in_doc: &DocumentURI, rel_path: &str, relational: &RDFStore, load: bool, iter: impl Iterator<Item = Triple>, )

pub(super) fn get_filepath( &self, path: Option<&Name>, name: &NameStep, language: Language, filename: &str, ) -> Option<PathBuf>

fn load_document( &self, path: Option<&Name>, name: &NameStep, language: Language, ) -> Option<UncheckedDocument>

pub fn load_html_body( &self, path: Option<&Name>, name: &NameStep, language: Language, full: bool, ) -> Option<(Vec<CSS>, String)>

pub fn load_html_body_async<'a>( &self, path: Option<&'a Name>, name: &'a NameStep, language: Language, full: bool, ) -> Option<impl Future<Output = Option<(Vec<CSS>, String)>> + 'a>

Available on crate feature tokio only.

pub fn load_html_full_async<'a>( &self, path: Option<&'a Name>, name: &'a NameStep, language: Language, ) -> Option<impl Future<Output = Option<String>> + 'a>

Available on crate feature tokio only.

pub fn load_html_full( &self, path: Option<&Name>, name: &NameStep, language: Language, ) -> Option<String>

pub fn load_html_fragment( &self, path: Option<&Name>, name: &NameStep, language: Language, range: DocumentRange, ) -> Option<(Vec<CSS>, String)>

pub fn load_reference<T: Resourcable>( &self, path: Option<&Name>, name: &NameStep, language: Language, range: DocumentRange, ) -> Result<T>

pub fn load_html_fragment_async<'a>( &self, path: Option<&'a Name>, name: &'a NameStep, language: Language, range: DocumentRange, ) -> Option<impl Future<Output = Option<(Vec<CSS>, String)>> + 'a>

Available on crate feature tokio only.

pub fn load<D: BuildArtifact>(&self, relative_path: &str) -> Result<D, Error>

Errors

fn escape_module_name(in_path: &Path, name: &NameStep) -> PathBuf

fn save_omdoc_result(&self, top: &Path, result: &OMDocResult)

pub fn get_log(&self, relative_path: &str, target: BuildTargetId) -> PathBuf

pub fn save( &self, relative_path: &str, log: Either<String, PathBuf>, from: BuildTargetId, result: Option<BuildResultArtifact>, )

Trait Implementations

impl Debug for LocalArchive

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

Formats the value using the given formatter.