Struct ReleaseMetadata

pub struct ReleaseMetadata<'a> {
    pub copyright: &'a str,
    pub description: &'a str,
    pub engine: &'a str,
    pub engine_version: &'a str,
    pub patchlevel: &'a str,
    pub platform: &'a str,
    pub release_date: &'a str,
    pub revision: &'a str,
    pub ruby_version: &'a str,
    pub compiler_version: Option<&'a str>,
}

Information about an Artichoke build.

This build information is injected into artichoke-backend by the artichoke crate at interpreter initialization time.

Fields

copyright: &'a str

Copyright information.

This value will populate the RUBY_COPYRIGHT constant.

Examples

artichoke - Copyright (c) 2019-2020 Ryan Lopopolo \<rjl@hyperbo.la\>

description: &'a str

A description of the current build.

This value will populate the RUBY_DESCRIPTION constant.

Examples

artichoke 0.1.0-pre.0 (2021-01-12 revision 4009) [x86_64-apple-darwin]

engine: &'a str

The engine, or VM, used in the current build.

This value will populate the RUBY_ENGINE constant.

Examples

artichoke-mruby

engine_version: &'a str

The version of the engine, or VM, used in the current build.

This value will populate the RUBY_ENGINE_VERSION constant.

Examples

0.1.0-pre.0

patchlevel: &'a str

The patch level the current build.

This value will populate the RUBY_PATCHLEVEL constant.

Examples

0

platform: &'a str

The target triple of the platform this build targets.

The platform will be a Rust or LLVM target triple.

This value will populate the RUBY_PLATFORM constant.

Examples

x86_64-apple-darwin

release_date: &'a str

The build date of this release.

This value will populate the RUBY_RELEASE_DATE constant.

Examples

2021-01-12

revision: &'a str

The target MRI Ruby version for this build.

This value will populate the RUBY_VERSION constant.

Examples

3.1.2

ruby_version: &'a str

The target MRI Ruby version for this build.

This value will populate the RUBY_VERSION constant.

Examples

3.1.2

compiler_version: Option<&'a str>

A description of the compiler used to build Artichoke.

This value will populate the ARTICHOKE_COMPILER_VERSION constant.

Examples

rustc 1.49.0 (e1884a8e3 2020-12-29) on x86_64-apple-darwin

Implementations

impl<'a> ReleaseMetadata<'a>

pub const fn new() -> Self

pub fn with_ruby_copyright(self, copyright: &'a str) -> Self

Set copyright information.

This value will populate the RUBY_COPYRIGHT constant.

Examples

artichoke - Copyright (c) 2019-2020 Ryan Lopopolo \<rjl@hyperbo.la\>

pub fn with_ruby_description(self, description: &'a str) -> Self

Set a description of the current build.

This value will populate the RUBY_DESCRIPTION constant.

Examples

artichoke 0.1.0-pre.0 (2021-01-12 revision 4009) [x86_64-apple-darwin]

pub fn with_ruby_engine(self, engine: &'a str) -> Self

Set the engine, or VM, used in the current build.

This value will populate the RUBY_ENGINE constant.

Examples

artichoke-mruby

pub fn with_ruby_engine_version(self, engine_version: &'a str) -> Self

Set the version of the engine, or VM, used in the current build.

This value will populate the RUBY_ENGINE_VERSION constant.

Examples

0.1.0-pre.0

pub fn with_ruby_patchlevel(self, patchlevel: &'a str) -> Self

Set the patch level the current build.

This value will populate the RUBY_PATCHLEVEL constant.

Examples

0

pub fn with_ruby_platform(self, platform: &'a str) -> Self

Set the target triple of the platform this build targets.

The platform will be a Rust or LLVM target triple.

This value will populate the RUBY_PLATFORM constant.

Examples

x86_64-apple-darwin

pub fn with_ruby_release_date(self, release_date: &'a str) -> Self

Set the build date of this release.

This value will populate the RUBY_RELEASE_DATE constant.

Examples

2021-01-12

pub fn with_ruby_revision(self, revision: &'a str) -> Self

Set the target MRI Ruby version for this build.

This value will populate the RUBY_VERSION constant.

Examples

3.1.2

pub fn with_ruby_version(self, ruby_version: &'a str) -> Self

Set the target MRI Ruby version for this build.

This value will populate the RUBY_VERSION constant.

Examples

3.1.2

pub fn with_artichoke_compiler_version( self, compiler_version: Option<&'a str>, ) -> Self

Set a description of the compiler used to build Artichoke.

This value will populate the ARTICHOKE_COMPILER_VERSION constant.

Examples

rustc 1.49.0 (e1884a8e3 2020-12-29) on x86_64-apple-darwin

pub const fn ruby_copyright(&self) -> &str

Copyright information.

This value will populate the RUBY_COPYRIGHT constant.

Examples

artichoke - Copyright (c) 2019-2020 Ryan Lopopolo \<rjl@hyperbo.la\>

pub const fn ruby_description(&self) -> &str

A description of the current build.

This value will populate the RUBY_DESCRIPTION constant.

Examples

artichoke 0.1.0-pre.0 (2021-01-12 revision 4009) [x86_64-apple-darwin]

pub const fn ruby_engine(&self) -> &str

The engine, or VM, used in the current build.

This value will populate the RUBY_ENGINE constant.

Examples

artichoke-mruby

pub const fn ruby_engine_version(&self) -> &str

The version of the engine, or VM, used in the current build.

This value will populate the RUBY_ENGINE_VERSION constant.

Examples

0.1.0-pre.0

pub const fn ruby_patchlevel(&self) -> &str

The patch level the current build.

This value will populate the RUBY_PATCHLEVEL constant.

Examples

0

pub const fn ruby_platform(&self) -> &str

The target triple of the platform this build targets.

The platform will be a Rust or LLVM target triple.

This value will populate the RUBY_PLATFORM constant.

Examples

x86_64-apple-darwin

pub const fn ruby_release_date(&self) -> &str

The build date of this release.

This value will populate the RUBY_RELEASE_DATE constant.

Examples

2021-01-12

pub const fn ruby_revision(&self) -> &str

The target MRI Ruby version for this build.

This value will populate the RUBY_VERSION constant.

Examples

3.1.2

pub const fn ruby_version(&self) -> &str

The target MRI Ruby version for this build.

This value will populate the RUBY_VERSION constant.

Examples

3.1.2

pub const fn artichoke_compiler_version(&self) -> Option<&str>

A description of the compiler used to build Artichoke.

This value will populate the ARTICHOKE_COMPILER_VERSION constant.

Examples

rustc 1.49.0 (e1884a8e3 2020-12-29) on x86_64-apple-darwin

Trait Implementations

impl<'a> Clone for ReleaseMetadata<'a>

fn clone(&self) -> ReleaseMetadata<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ReleaseMetadata<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ReleaseMetadata<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Hash for ReleaseMetadata<'a>

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

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<'a> Ord for ReleaseMetadata<'a>

fn cmp(&self, other: &ReleaseMetadata<'a>) -> 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<'a> PartialEq for ReleaseMetadata<'a>

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

fn partial_cmp(&self, other: &ReleaseMetadata<'a>) -> 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<'a> ReleaseMetadata for ReleaseMetadata<'a>

fn ruby_copyright(&self) -> &str

Copyright information.

fn ruby_description(&self) -> &str

A description of the current build.

fn ruby_engine(&self) -> &str

The engine, or VM, used in the current build.

fn ruby_engine_version(&self) -> &str

The version of the engine, or VM, used in the current build.

fn ruby_patchlevel(&self) -> &str

The patch level the current build.

fn ruby_platform(&self) -> &str

The target triple of the platform this build targets.

fn ruby_release_date(&self) -> &str

The build date of this release.

fn ruby_revision(&self) -> &str

The revision count of the Artichoke git repository used for this build.

fn ruby_version(&self) -> &str

The target MRI Ruby version for this build.

fn artichoke_compiler_version(&self) -> Option<&str>

A description of the compiler used to build Artichoke.

impl<'a> Copy for ReleaseMetadata<'a>

impl<'a> Eq for ReleaseMetadata<'a>

impl<'a> StructuralPartialEq for ReleaseMetadata<'a>