Struct EntryState 

pub struct EntryState { /* private fields */ }

The state of the entry.

Implementations

impl EntryState

pub fn new_detached() -> EntryState

Creates an entry state with no workspace root and no main file.

pub fn new_workspace(root: Arc<Path>) -> EntryState

Creates an entry state with a workspace root and no main file.

pub fn new_rootless(main: VirtualPath) -> EntryState

Creates an entry state without permission to access the file system.

pub fn new_rooted_by_id(root: Arc<Path>, main: FileId) -> EntryState

Creates an entry state with a workspace root and an main file.

pub fn new_rooted(root: Arc<Path>, main: Option<VirtualPath>) -> EntryState

Creates an entry state with a workspace root and an optional main file.

pub fn new_rooted_by_parent(entry: Arc<Path>) -> Option<EntryState>

Creates an entry state with only a main file given.

pub fn main(&self) -> Option<FileId>

Gets the main file id.

pub fn root(&self) -> Option<Arc<Path>>

Gets the specified root directory.

pub fn workspace_root(&self) -> Option<Arc<Path>>

Gets the root directory of the main file.

pub fn select_in_workspace(&self, path: &Path) -> EntryState

Selects an entry in the workspace.

pub fn try_select_path_in_workspace( &self, path: &Path, ) -> Result<Option<EntryState>, Error>

Tries to select an entry in the workspace.

If a workspace root is set, the path must be inside that root and the selected entry keeps the same root. Selecting a path outside the root is rejected because that has undefined workspace semantics.

If no workspace root is set, selection falls back to rooting the entry by its parent directory. This matches typst-cli behavior with and without an explicit --root.

pub fn is_detached(&self) -> bool

Checks if the world is detached.

pub fn is_inactive(&self) -> bool

Checks if the world is inactive.

pub fn is_in_package(&self) -> bool

Checks if the world is in a package.

Trait Implementations

impl Clone for EntryState

fn clone(&self) -> EntryState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntryState

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

Formats the value using the given formatter.

impl Default for EntryState

fn default() -> EntryState

Returns the “default value” for a type.

impl Hash for EntryState

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

where __H: Hasher,

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 PartialEq for EntryState

fn eq(&self, other: &EntryState) -> 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 TryFrom<EntryOpts> for EntryState

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: EntryOpts, ) -> Result<EntryState, <EntryState as TryFrom<EntryOpts>>::Error>

Performs the conversion.

impl Eq for EntryState

impl StructuralPartialEq for EntryState