Struct Version

pub struct Version(/* private fields */);

A version with an arbitrary number of components.

The first three components have names that can be used as fields: major, minor, patch. All following components do not have names.

The list of components is semantically extended by an infinite list of zeros. This means that, for example, 0.8 is the same as 0.8.0. As a special case, the empty version (that has no components at all) is the same as 0, 0.0, 0.0.0, and so on.

The current version of the Typst compiler is available as sys.version.

You can convert a version to an array of explicitly given components using the array constructor.

Implementations

impl Version

pub const COMPONENTS: [&'static str; 3]

The names for the first components of a version.

pub fn new() -> Version

Create a new (empty) version.

pub fn component(&self, name: &str) -> Result<i64, EcoString>

Get a named component of a version.

Always non-negative. Returns 0 if the version isn’t specified to the necessary length.

pub fn push(&mut self, component: u32)

Push a component to the end of this version.

pub fn values(&self) -> &[u32]

The values of the version

impl Version

pub fn construct(components: Vec<VersionComponents>) -> Version

Creates a new version.

It can have any number of components (even zero).

#version() \
#version(1) \
#version(1, 2, 3, 4) \
#version((1, 2, 3, 4)) \
#version((1, 2), 3)

As a practical use case, this allows comparing the current version ({sys.version}) to a specific one.

Current version: #sys.version \
#(sys.version >= version(0, 14, 0)) \
#(version(3, 2, 0) > version(4, 1, 0))

pub fn at(&self, index: i64) -> Result<i64, EcoString>

Retrieves a component of a version.

The returned integer is always non-negative. Returns 0 if the version isn’t specified to the necessary length.

Trait Implementations

impl Clone for Version

fn clone(&self) -> Version

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Version

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

Formats the value using the given formatter.

impl Default for Version

fn default() -> Version

Returns the “default value” for a type.

impl Display for Version

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

Formats the value using the given formatter.

impl FromIterator<u32> for Version

fn from_iter<T>(iter: T) -> Version

where T: IntoIterator<Item = u32>,

Creates a value from an iterator.

impl FromValue for Version

fn from_value(value: Value) -> Result<Version, HintedString>

Try to cast the value into an instance of Self.

impl Hash for Version

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 IntoIterator for Version

type Item = u32

The type of the elements being iterated over.

type IntoIter = IntoIter<u32>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Version as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoValue for Version

fn into_value(self) -> Value

Cast this type into a value.

impl NativeScope for Version

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl NativeType for Version

const NAME: &'static str = "version"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust type.

impl Ord for Version

fn cmp(&self, other: &Version) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Version

fn eq(&self, other: &Version) -> 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 PartialOrd for Version

fn partial_cmp(&self, other: &Version) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Reflect for Version

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for Version

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Eq for Version