artichoke_core::release_metadata

Trait ReleaseMetadata

Source
pub trait ReleaseMetadata {
    // Required methods
    fn ruby_copyright(&self) -> &str;
    fn ruby_description(&self) -> &str;
    fn ruby_engine(&self) -> &str;
    fn ruby_engine_version(&self) -> &str;
    fn ruby_patchlevel(&self) -> &str;
    fn ruby_platform(&self) -> &str;
    fn ruby_release_date(&self) -> &str;
    fn ruby_revision(&self) -> &str;
    fn ruby_version(&self) -> &str;
    fn artichoke_compiler_version(&self) -> Option<&str>;
}
Expand description

Information about an Artichoke build.

Implementations of this trait are used to set global Ruby constants that describe the current build.

Required Methods§

Copyright information.

This value will populate the RUBY_COPYRIGHT constant.

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

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]
Source

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
Source

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
Source

fn ruby_patchlevel(&self) -> &str

The patch level the current build.

This value will populate the RUBY_PATCHLEVEL constant.

§Examples
0
Source

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
Source

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
Source

fn ruby_revision(&self) -> &str

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

This value will populate the RUBY_REVISION constant.

§Examples
4009
Source

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
Source

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

Implementors§