Expand description
just
is primarily used as a command-line binary, but does provide a
limited public library interface.
Please keep in mind that there are no semantic version guarantees for the library interface. It may break or change at any time.
Re-exportsĀ§
pub use crate::alias::Alias;
pub use crate::analyzer::Analyzer;
pub use crate::argument_parser::ArgumentParser;
pub use crate::assignment::Assignment;
pub use crate::assignment_resolver::AssignmentResolver;
pub use crate::ast::Ast;
pub use crate::attribute::Attribute;
pub use crate::binding::Binding;
pub use crate::color::Color;
pub use crate::color_display::ColorDisplay;
pub use crate::command_color::CommandColor;
pub use crate::command_ext::CommandExt;
pub use crate::compilation::Compilation;
pub use crate::compile_error::CompileError;
pub use crate::compile_error_kind::CompileErrorKind;
pub use crate::compiler::Compiler;
pub use crate::condition::Condition;
pub use crate::conditional_operator::ConditionalOperator;
pub use crate::config::Config;
pub use crate::config_error::ConfigError;
pub use crate::constants::constants;
pub use crate::count::Count;
pub use crate::delimiter::Delimiter;
pub use crate::dependency::Dependency;
pub use crate::dump_format::DumpFormat;
pub use crate::enclosure::Enclosure;
pub use crate::error::Error;
pub use crate::evaluator::Evaluator;
pub use crate::execution_context::ExecutionContext;
pub use crate::executor::Executor;
pub use crate::expression::Expression;
pub use crate::fragment::Fragment;
pub use crate::function::Function;
pub use crate::interpreter::Interpreter;
pub use crate::interrupt_guard::InterruptGuard;
pub use crate::interrupt_handler::InterruptHandler;
pub use crate::item::Item;
pub use crate::justfile::Justfile;
pub use crate::keyed::Keyed;
pub use crate::keyword::Keyword;
pub use crate::lexer::Lexer;
pub use crate::line::Line;
pub use crate::list::List;
pub use crate::load_dotenv::load_dotenv;
pub use crate::loader::Loader;
pub use crate::module_path::ModulePath;
pub use crate::name::Name;
pub use crate::namepath::Namepath;
pub use crate::ordinal::Ordinal;
pub use crate::output::output;
pub use crate::output_error::OutputError;
pub use crate::parameter::Parameter;
pub use crate::parameter_kind::ParameterKind;
pub use crate::parser::Parser;
pub use crate::platform::Platform;
pub use crate::platform_interface::PlatformInterface;
pub use crate::position::Position;
pub use crate::positional::Positional;
pub use crate::ran::Ran;
pub use crate::range_ext::RangeExt;
pub use crate::recipe::Recipe;
pub use crate::recipe_resolver::RecipeResolver;
pub use crate::recipe_signature::RecipeSignature;
pub use crate::scope::Scope;
pub use crate::search::Search;
pub use crate::search_config::SearchConfig;
pub use crate::search_error::SearchError;
pub use crate::set::Set;
pub use crate::setting::Setting;
pub use crate::settings::Settings;
pub use crate::shebang::Shebang;
pub use crate::show_whitespace::ShowWhitespace;
pub use crate::source::Source;
pub use crate::string_delimiter::StringDelimiter;
pub use crate::string_kind::StringKind;
pub use crate::string_literal::StringLiteral;
pub use crate::subcommand::Subcommand;
pub use crate::suggestion::Suggestion;
pub use crate::table::Table;
pub use crate::thunk::Thunk;
pub use crate::token::Token;
pub use crate::token_kind::TokenKind;
pub use crate::unresolved_dependency::UnresolvedDependency;
pub use crate::unresolved_recipe::UnresolvedRecipe;
pub use crate::unstable_feature::UnstableFeature;
pub use crate::use_color::UseColor;
pub use crate::variables::Variables;
pub use crate::verbosity::Verbosity;
pub use crate::warning::Warning;
pub use crate::run::run;
ModulesĀ§
- alias
- analyzer
- argument_
parser - assignment
- assignment_
resolver - ast
- attribute
- binding
- cmp
- Utilities for comparing and ordering values.
- color
- color_
display - command_
color - command_
ext - compilation
- compile_
error - compile_
error_ kind - compiler
- completions
- condition
- conditional_
operator - config
- config_
error - constants
- count
- delimiter
- dependency
- dump_
format - enclosure
- env
- Inspection and manipulation of the processās environment.
- error
- evaluator
- execution_
context - executor
- expression
- fmt
- Utilities for formatting and printing
String
s. - fragment
- fs
- Filesystem manipulation operations.
- function
- interpreter
- interrupt_
guard - interrupt_
handler - io
- Traits, helpers, and type definitions for core I/O functionality.
- item
- iter
- Composable external iteration.
- justfile
- keyed
- keyword
- lexer
- line
- list
- load_
dotenv - loader
- mem
- Basic functions for dealing with memory.
- module_
path - name
- namepath
- ordinal
- output
- output_
error - parameter
- parameter_
kind - parser
- path
- Cross-platform path manipulation.
- platform
- platform_
interface - position
- positional
- process
- A module for working with processes.
- ran
- range_
ext - recipe
- recipe_
resolver - recipe_
signature - run
- scope
- search
- search_
config - search_
error - set
- setting
- settings
- shebang
- show_
whitespace - source
- str
- Utilities for the
str
primitive type. - string_
delimiter - string_
kind - string_
literal - subcommand
- suggestion
- table
- thunk
- token
- token_
kind - unindent
- unresolved_
dependency - unresolved_
recipe - unstable_
feature - use_
color - variables
- vec
- A contiguous growable array type with heap-allocated contents, written
Vec<T>
. - verbosity
- warning
MacrosĀ§
StructsĀ§
- Arena
- An arena of objects of type
T
. - BTree
Map - An ordered map based on a B-Tree.
- BTree
Set - An ordered set based on a B-Tree.
- Chars
- An iterator over the
char
s of a string slice. - Command
- A process builder, providing fine-grained control over how a new process should be spawned.
- Exit
Status - Describes the result of a process after it has terminated.
- Formatter
- Configuration for formatting.
- HashMap
- A hash map implemented with quadratic probing and SIMD lookup.
- HashSet
- A hash set implemented as a
HashMap
where the value is()
. - Lazy
- A value which is initialized on the first access.
- Mutex
- A mutual exclusion primitive useful for protecting shared data
- Mutex
Guard - An RAII implementation of a āscoped lockā of a mutex. When this structure is dropped (falls out of scope), the lock will be unlocked.
- Once
Lock - A synchronization primitive which can nominally be written to only once.
- OsString
- A type that can represent owned, mutable platform-native strings, but is cheaply inter-convertible with Rust strings.
- Path
- A slice of a path (akin to
str
). - PathBuf
- An owned, mutable path (akin to
String
). - Range
- A (half-open) range bounded inclusively below and exclusively above
(
start..end
). - Range
Inclusive - A range bounded inclusively below and above (
start..=end
). - Rc
- A single-threaded reference-counting pointer. āRcā stands for āReference Countedā.
- Regex
- A compiled regular expression for searching Unicode haystacks.
- Stdio
- Describes what to do with a standard I/O stream for a child process when
passed to the
stdin
,stdout
, andstderr
methods ofCommand
. - Utf8
Path - A slice of a UTF-8 path (akin to
str
).
EnumsĀ§
- Cow
- A clone-on-write smart pointer.
ConstantsĀ§
TraitsĀ§
- Debug
?
formatting.- Deref
- Used for immutable dereferencing operations, like
*v
. - Display
- Format trait for an empty format,
{}
. - From
Iterator - Conversion from an
Iterator
. - Index
- Used for indexing operations (
container[index]
) in immutable contexts. - Lexiclean
- Read
- The
Read
trait allows for reading bytes from a source. - Result
Ext - Additions to
Result
. - Seek
- The
Seek
trait provides a cursor which can be moved within a stream of bytes. - Serialize
- A data structure that can be serialized into any data format supported by Serde.
- Serialize
Map - Returned from
Serializer::serialize_map
. - Serialize
Seq - Returned from
Serializer::serialize_seq
. - Serializer
- A data format that can serialize any data structure supported by Serde.
- Unicode
Width Char - Methods for determining displayed width of Unicode characters.
- Unicode
Width Str - Methods for determining displayed width of Unicode strings.
- Value
Enum - Parse arguments into enums.
- Write
- A trait for objects which are byte-oriented sinks.
FunctionsĀ§
- edit_
distance - Returns the edit distance between strings
a
andb
. - tempfile
- Create a new temporary file.
Type AliasesĀ§
Attribute MacrosĀ§
- derive_
where - Item-level options:
Derive MacrosĀ§
- Debug
- Derive macro generating an impl of the trait
Debug
. - Display
- Converts enum variants to strings.
- Enum
Discriminants - Generate a new type with only the discriminant names.
- Enum
String - Converts strings to enum variants based on their name.
- Into
Static Str - Implements
From<MyEnum> for &'static str
on an enum. - Serialize
- Snafu
- Value
Enum - Generates the
ValueEnum
impl.