artichoke_backend/release_metadata.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
//! Information about an Artichoke build.
//!
//! Release metadata allows populating Ruby constants that describe the build,
//! like `RUBY_COPYRIGHT` for copyright information or `RUBY_PLATFORM` for
//! target architecture.
use artichoke_core::release_metadata;
/// Information about an Artichoke build.
///
/// This build information is injected into `artichoke-backend` by the
/// `artichoke` crate at interpreter initialization time.
#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub struct ReleaseMetadata<'a> {
/// Copyright information.
///
/// This value will populate the `RUBY_COPYRIGHT` constant.
///
/// # Examples
///
/// ```text
/// artichoke - Copyright (c) 2019-2020 Ryan Lopopolo \<rjl@hyperbo.la\>
/// ```
pub copyright: &'a str,
/// A description of the current build.
///
/// This value will populate the `RUBY_DESCRIPTION` constant.
///
/// # Examples
///
/// ```text
/// artichoke 0.1.0-pre.0 (2021-01-12 revision 4009) [x86_64-apple-darwin]
/// ```
pub description: &'a str,
/// The engine, or VM, used in the current build.
///
/// This value will populate the `RUBY_ENGINE` constant.
///
/// # Examples
///
/// ```text
/// artichoke-mruby
/// ```
pub engine: &'a str,
/// The version of the engine, or VM, used in the current build.
///
/// This value will populate the `RUBY_ENGINE_VERSION` constant.
///
/// # Examples
///
/// ```text
/// 0.1.0-pre.0
/// ```
pub engine_version: &'a str,
/// The patch level the current build.
///
/// This value will populate the `RUBY_PATCHLEVEL` constant.
///
/// # Examples
///
/// ```text
/// 0
/// ```
pub patchlevel: &'a str,
/// The target triple of the platform this build targets.
///
/// The platform will be a [Rust or LLVM target triple][triple].
///
/// This value will populate the `RUBY_PLATFORM` constant.
///
/// # Examples
///
/// ```text
/// x86_64-apple-darwin
/// ```
///
/// [triple]: https://forge.rust-lang.org/release/platform-support.html
pub platform: &'a str,
/// The build date of this release.
///
/// This value will populate the `RUBY_RELEASE_DATE` constant.
///
/// # Examples
///
/// ```text
/// 2021-01-12
/// ```
pub release_date: &'a str,
/// The target MRI Ruby version for this build.
///
/// This value will populate the `RUBY_VERSION` constant.
///
/// # Examples
///
/// ```text
/// 3.1.2
/// ```
pub revision: &'a str,
/// The target MRI Ruby version for this build.
///
/// This value will populate the `RUBY_VERSION` constant.
///
/// # Examples
///
/// ```text
/// 3.1.2
/// ```
pub ruby_version: &'a str,
/// A description of the compiler used to build Artichoke.
///
/// This value will populate the `ARTICHOKE_COMPILER_VERSION` constant.
///
/// # Examples
///
/// ```text
/// rustc 1.49.0 (e1884a8e3 2020-12-29) on x86_64-apple-darwin
/// ```
pub compiler_version: Option<&'a str>,
}
impl<'a> Default for ReleaseMetadata<'a> {
fn default() -> Self {
Self::new()
}
}
impl<'a> release_metadata::ReleaseMetadata for ReleaseMetadata<'a> {
fn ruby_copyright(&self) -> &str {
self.copyright
}
fn ruby_description(&self) -> &str {
self.description
}
fn ruby_engine(&self) -> &str {
self.engine
}
fn ruby_engine_version(&self) -> &str {
self.engine_version
}
fn ruby_patchlevel(&self) -> &str {
self.patchlevel
}
fn ruby_platform(&self) -> &str {
self.platform
}
fn ruby_release_date(&self) -> &str {
self.release_date
}
fn ruby_revision(&self) -> &str {
self.revision
}
fn ruby_version(&self) -> &str {
self.ruby_version
}
fn artichoke_compiler_version(&self) -> Option<&str> {
self.compiler_version
}
}
impl<'a> ReleaseMetadata<'a> {
#[must_use]
pub const fn new() -> Self {
Self {
copyright: "Copyright (c) 2019 Ryan Lopopolo <rjl@hyperbo.la>",
description: "Artichoke Ruby",
engine: "artichoke-mruby",
engine_version: env!("CARGO_PKG_VERSION"),
patchlevel: "0",
platform: "host",
release_date: "",
revision: "1",
ruby_version: "3.1.2",
compiler_version: Some("rustc"),
}
}
/// Set copyright information.
///
/// This value will populate the `RUBY_COPYRIGHT` constant.
///
/// # Examples
///
/// ```text
/// artichoke - Copyright (c) 2019-2020 Ryan Lopopolo \<rjl@hyperbo.la\>
/// ```
#[must_use]
pub fn with_ruby_copyright(mut self, copyright: &'a str) -> Self {
self.copyright = copyright;
self
}
/// Set a description of the current build.
///
/// This value will populate the `RUBY_DESCRIPTION` constant.
///
/// # Examples
///
/// ```text
/// artichoke 0.1.0-pre.0 (2021-01-12 revision 4009) [x86_64-apple-darwin]
/// ```
#[must_use]
pub fn with_ruby_description(mut self, description: &'a str) -> Self {
self.description = description;
self
}
/// Set the engine, or VM, used in the current build.
///
/// This value will populate the `RUBY_ENGINE` constant.
///
/// # Examples
///
/// ```text
/// artichoke-mruby
/// ```
#[must_use]
pub fn with_ruby_engine(mut self, engine: &'a str) -> Self {
self.engine = engine;
self
}
/// Set the version of the engine, or VM, used in the current build.
///
/// This value will populate the `RUBY_ENGINE_VERSION` constant.
///
/// # Examples
///
/// ```text
/// 0.1.0-pre.0
/// ```
#[must_use]
pub fn with_ruby_engine_version(mut self, engine_version: &'a str) -> Self {
self.engine_version = engine_version;
self
}
/// Set the patch level the current build.
///
/// This value will populate the `RUBY_PATCHLEVEL` constant.
///
/// # Examples
///
/// ```text
/// 0
/// ```
#[must_use]
pub fn with_ruby_patchlevel(mut self, patchlevel: &'a str) -> Self {
self.patchlevel = patchlevel;
self
}
/// Set the target triple of the platform this build targets.
///
/// The platform will be a [Rust or LLVM target triple][triple].
///
/// This value will populate the `RUBY_PLATFORM` constant.
///
/// # Examples
///
/// ```text
/// x86_64-apple-darwin
/// ```
///
/// [triple]: https://forge.rust-lang.org/release/platform-support.html
#[must_use]
pub fn with_ruby_platform(mut self, platform: &'a str) -> Self {
self.platform = platform;
self
}
/// Set the build date of this release.
///
/// This value will populate the `RUBY_RELEASE_DATE` constant.
///
/// # Examples
///
/// ```text
/// 2021-01-12
/// ```
#[must_use]
pub fn with_ruby_release_date(mut self, release_date: &'a str) -> Self {
self.release_date = release_date;
self
}
/// Set the target MRI Ruby version for this build.
///
/// This value will populate the `RUBY_VERSION` constant.
///
/// # Examples
///
/// ```text
/// 3.1.2
/// ```
#[must_use]
pub fn with_ruby_revision(mut self, revision: &'a str) -> Self {
self.revision = revision;
self
}
/// Set the target MRI Ruby version for this build.
///
/// This value will populate the `RUBY_VERSION` constant.
///
/// # Examples
///
/// ```text
/// 3.1.2
/// ```
#[must_use]
pub fn with_ruby_version(mut self, ruby_version: &'a str) -> Self {
self.ruby_version = ruby_version;
self
}
/// Set a description of the compiler used to build Artichoke.
///
/// This value will populate the `ARTICHOKE_COMPILER_VERSION` constant.
///
/// # Examples
///
/// ```text
/// rustc 1.49.0 (e1884a8e3 2020-12-29) on x86_64-apple-darwin
/// ```
#[must_use]
pub fn with_artichoke_compiler_version(mut self, compiler_version: Option<&'a str>) -> Self {
self.compiler_version = compiler_version;
self
}
/// Copyright information.
///
/// This value will populate the `RUBY_COPYRIGHT` constant.
///
/// # Examples
///
/// ```text
/// artichoke - Copyright (c) 2019-2020 Ryan Lopopolo \<rjl@hyperbo.la\>
/// ```
#[must_use]
pub const fn ruby_copyright(&self) -> &str {
self.copyright
}
/// A description of the current build.
///
/// This value will populate the `RUBY_DESCRIPTION` constant.
///
/// # Examples
///
/// ```text
/// artichoke 0.1.0-pre.0 (2021-01-12 revision 4009) [x86_64-apple-darwin]
/// ```
#[must_use]
pub const fn ruby_description(&self) -> &str {
self.description
}
/// The engine, or VM, used in the current build.
///
/// This value will populate the `RUBY_ENGINE` constant.
///
/// # Examples
///
/// ```text
/// artichoke-mruby
/// ```
#[must_use]
pub const fn ruby_engine(&self) -> &str {
self.engine
}
/// The version of the engine, or VM, used in the current build.
///
/// This value will populate the `RUBY_ENGINE_VERSION` constant.
///
/// # Examples
///
/// ```text
/// 0.1.0-pre.0
/// ```
#[must_use]
pub const fn ruby_engine_version(&self) -> &str {
self.engine_version
}
/// The patch level the current build.
///
/// This value will populate the `RUBY_PATCHLEVEL` constant.
///
/// # Examples
///
/// ```text
/// 0
/// ```
#[must_use]
pub const fn ruby_patchlevel(&self) -> &str {
self.patchlevel
}
/// The target triple of the platform this build targets.
///
/// The platform will be a [Rust or LLVM target triple][triple].
///
/// This value will populate the `RUBY_PLATFORM` constant.
///
/// # Examples
///
/// ```text
/// x86_64-apple-darwin
/// ```
///
/// [triple]: https://forge.rust-lang.org/release/platform-support.html
#[must_use]
pub const fn ruby_platform(&self) -> &str {
self.platform
}
/// The build date of this release.
///
/// This value will populate the `RUBY_RELEASE_DATE` constant.
///
/// # Examples
///
/// ```text
/// 2021-01-12
/// ```
#[must_use]
pub const fn ruby_release_date(&self) -> &str {
self.release_date
}
/// The target MRI Ruby version for this build.
///
/// This value will populate the `RUBY_VERSION` constant.
///
/// # Examples
///
/// ```text
/// 3.1.2
/// ```
#[must_use]
pub const fn ruby_revision(&self) -> &str {
self.revision
}
/// The target MRI Ruby version for this build.
///
/// This value will populate the `RUBY_VERSION` constant.
///
/// # Examples
///
/// ```text
/// 3.1.2
/// ```
#[must_use]
pub const fn ruby_version(&self) -> &str {
self.ruby_version
}
/// A description of the compiler used to build Artichoke.
///
/// This value will populate the `ARTICHOKE_COMPILER_VERSION` constant.
///
/// # Examples
///
/// ```text
/// rustc 1.49.0 (e1884a8e3 2020-12-29) on x86_64-apple-darwin
/// ```
#[must_use]
pub const fn artichoke_compiler_version(&self) -> Option<&str> {
self.compiler_version
}
}