Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

struct libtmux-rs latest

ReleaseSuffix

The suffix of a numbered tmux release.

Source and package
Qualified name
libtmux::version::ReleaseSuffix
Module
version
Package
libtmux
Source
crates/libtmux/src/version.rs
struct version.ReleaseSuffix

Description#

Release candidates sort before a final release, while lowercase patch letters sort after it.

Examples#

use libtmux::{ReleaseSuffix, ReleaseVersion};
// tmux's two suffix shapes order differently: a patch letter comes *after*
// the plain release, and a release candidate comes before it.
let plain = ReleaseVersion::new(3, 5, ReleaseSuffix::FINAL);
let patched = ReleaseVersion::new(3, 5, ReleaseSuffix::patch('a').expect("a patch letter"));
let candidate = ReleaseVersion::new(
3,
5,
ReleaseSuffix::release_candidate(1).expect("one is nonzero"),
);
assert!(candidate < plain);
assert!(plain < patched);
// Only those two shapes exist, so anything else is rejected rather than
// guessed at.
assert_eq!(ReleaseSuffix::patch('B'), None);
assert_eq!(ReleaseSuffix::release_candidate(0), None);

Members8#

Common operations6#

  • is_final method Return whether this suffix marks a final release.
  • is_release_candidate method Return whether this suffix marks a release candidate.
  • patch method Construct a lowercase patch-letter suffix.
  • patch_letter method Return the lowercase patch letter, if this is a patch release.
  • release_candidate method Construct a numbered release-candidate suffix.
  • release_candidate_number method Return the release-candidate number, if present.

Other members2#

  • FINAL: Self constant A final release with no suffix.
  • RELEASE_CANDIDATE: Self constant An unnumbered -rc suffix, canonically equivalent to -rc1.
Esc

Type to search.

Reference previewOpen reference