Skip to main content

Workspace

lux_lib::workspace

Struct Workspace 

Source 
pub struct Workspace { /* private fields */ }

Implementations§

Source§

impl Workspace

Source

pub fn current() -> Result<Option<Self>, WorkspaceError>

Source

pub fn current_or_err() -> Result<Self, WorkspaceError>

Source

pub fn root(&self) -> &WorkspaceRoot

The path where the root lux.toml resides.

Source

pub fn members(&self) -> &NonEmpty<Project>

The members of this workspace.

Source

pub fn members_mut(&mut self) -> &mut NonEmpty<Project>

Mutable reference to the members of this workspace.

Source

pub fn single_member_or_select( &self, name: &Option<PackageName>, ) -> Result<&Project, WorkspaceError>

Get a workspace member, defaulting to the first one if none is specified. Fails if a package name is specified, but not found.

Source

pub fn single_member_or_select_mut( &mut self, package: &Option<PackageName>, ) -> Result<&mut Project, WorkspaceError>

Get a mutable workspace member, defaulting to the first one if none is specified. Fails if a package name is specified, but not found.

Source

pub fn single_member(&self) -> Result<&Project, WorkspaceError>

Get the single member of this workspace, failing if it has multiple members.

Source

pub fn single_member_mut(&mut self) -> Result<&mut Project, WorkspaceError>

Get the single mutable member of this workspace, failing if it has multiple members.

Source

pub fn select_member( &self, package: &PackageName, ) -> Result<&Project, WorkspaceError>

Select a member of this workspace, failing if it is not found.

Source

pub fn select_member_mut( &mut self, package: &PackageName, ) -> Result<&mut Project, WorkspaceError>

Select a mutable member of this workspace, failing if it is not found.

Source

pub fn lockfile_path(&self) -> PathBuf

Get the lux.lock lockfile path.

Source

pub fn lockfile(&self) -> Result<WorkspaceLockfile<ReadOnly>, WorkspaceError>

Get the lux.lock lockfile in the project root.

Source

pub fn try_lockfile( &self, ) -> Result<Option<WorkspaceLockfile<ReadOnly>>, WorkspaceError>

Get the lux.lock lockfile in the project root, if present.

Source

pub fn tree(&self, config: &Config) -> Result<Tree, WorkspaceTreeError>

Source

pub fn lua_version( &self, config: &Config, ) -> Result<LuaVersion, LuaVersionError>

Source

pub fn test_tree(&self, config: &Config) -> Result<Tree, WorkspaceTreeError>

Source

pub fn build_tree(&self, config: &Config) -> Result<Tree, WorkspaceTreeError>

Source

pub fn luarc_path(&self) -> PathBuf

Get the .luarc.json or .emmyrc.json path.

Source

pub fn from_exact( start: impl AsRef<Path>, ) -> Result<Option<Self>, WorkspaceError>

Source

pub fn from(start: impl AsRef<Path>) -> Result<Option<Self>, WorkspaceError>

Trait Implementations§

Source§

impl Clone for Workspace

Source§

fn clone(&self) -> Workspace

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 Workspace

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<'src, T> IntoMaybe<'src, T> for T
where T: 'src,

Source§

type Proj<U: 'src> = U

Source§

fn map_maybe<R>( self, _f: impl FnOnce(&'src T) -> &'src R, g: impl FnOnce(T) -> R, ) -> <T as IntoMaybe<'src, T>>::Proj<R>
where R: 'src,

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<'p, T> Seq<'p, T> for T
where T: Clone,

Source§

type Item<'a> = &'a T where T: 'a

The item yielded by the iterator.
Source§

type Iter<'a> = Once<&'a T> where T: 'a

An iterator over the items within this container, by reference.
Source§

fn seq_iter(&self) -> <T as Seq<'p, T>>::Iter<'_>

Iterate over the elements of the container.
Source§

fn contains(&self, val: &T) -> bool
where T: PartialEq,

Check whether an item is contained within this sequence.
Source§

fn to_maybe_ref<'b>(item: <T as Seq<'p, T>>::Item<'b>) -> Maybe<T, &'p T>
where 'p: 'b,

Convert an item of the sequence into a MaybeRef.
Source§

impl<T, S> SpanWrap<S> for T
where S: WrappingSpan<T>,

Source§

fn with_span(self, span: S) -> <S as WrappingSpan<Self>>::Spanned

Invokes WrappingSpan::make_wrapped to wrap an AST node in a span.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> OrderedSeq<'_, T> for T
where T: Clone,