Struct Particle 

pub struct Particle {
    pub kind: ParticleKind,
}

A lightweight particle wrapper that delegates to the free helper functions.

Fields

kind: ParticleKind

The underlying particle kind.

Implementations

impl Particle

pub const fn new(kind: ParticleKind) -> Particle

Creates a new Particle from kind.

Examples

use use_particle::{Particle, ParticleKind};

let electron = Particle::new(ParticleKind::Electron);

assert_eq!(electron.kind, ParticleKind::Electron);

Examples found in repository

examples/facade_particle.rs (line 8)

fn main() {
    let electron = Particle::new(ParticleKind::Electron);

    assert_eq!(electron.family(), ParticleFamily::Lepton);
    assert_eq!(charge(ParticleKind::Electron).thirds, -3);
    assert_eq!(spin(ParticleKind::Photon).doubled, 2);
    assert_eq!(
        antiparticle(ParticleKind::Electron),
        Some(ParticleKind::Positron)
    );
    assert!(approx_eq(electron.charge().as_elementary_units(), -1.0,));
}

pub const fn family(&self) -> ParticleFamily

Returns the particle family.

Examples found in repository

examples/facade_particle.rs (line 10)

fn main() {
    let electron = Particle::new(ParticleKind::Electron);

    assert_eq!(electron.family(), ParticleFamily::Lepton);
    assert_eq!(charge(ParticleKind::Electron).thirds, -3);
    assert_eq!(spin(ParticleKind::Photon).doubled, 2);
    assert_eq!(
        antiparticle(ParticleKind::Electron),
        Some(ParticleKind::Positron)
    );
    assert!(approx_eq(electron.charge().as_elementary_units(), -1.0,));
}

pub const fn charge(&self) -> ElementaryCharge

Returns the exact charge.

Examples found in repository

examples/facade_particle.rs (line 17)

fn main() {
    let electron = Particle::new(ParticleKind::Electron);

    assert_eq!(electron.family(), ParticleFamily::Lepton);
    assert_eq!(charge(ParticleKind::Electron).thirds, -3);
    assert_eq!(spin(ParticleKind::Photon).doubled, 2);
    assert_eq!(
        antiparticle(ParticleKind::Electron),
        Some(ParticleKind::Positron)
    );
    assert!(approx_eq(electron.charge().as_elementary_units(), -1.0,));
}

pub const fn spin(&self) -> Spin

Returns the spin.

pub const fn statistics(&self) -> ParticleStatistics

Returns the particle statistics.

pub const fn antiparticle(&self) -> Option<Particle>

Returns the antiparticle when it is modeled by this crate.

pub const fn rest_mass_mev_c2(&self) -> Option<f64>

Returns the approximate rest mass in MeV/c^2.

pub const fn is_antiparticle(&self) -> bool

Returns true when this particle is represented as an antiparticle variant.

pub const fn is_self_antiparticle(&self) -> bool

Returns true when the particle is its own antiparticle.

Trait Implementations

impl Clone for Particle

fn clone(&self) -> Particle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Particle

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

Formats the value using the given formatter.

impl PartialEq for Particle

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

impl Eq for Particle

impl StructuralPartialEq for Particle