Skip to main content

SE3

Struct SE3 

Source
pub struct SE3 { /* private fields */ }
Expand description

SE(3) group element representing rigid body transformations in 3D.

Stored as a flat SVector<f64, 7> = [tx, ty, tz, qw, qx, qy, qz] for contiguous memory compatible with zero-copy faer views.

Implementations§

Source§

impl SE3

Source

pub const DIM: usize = 3

Space dimension - dimension of the ambient space that the group acts on

Source

pub const DOF: usize = 6

Degrees of freedom - dimension of the tangent space

Source

pub const REP_SIZE: usize = 7

Representation size - size of the underlying data representation

Source

pub fn identity() -> SE3

Get the identity element of the group.

Returns the neutral element e such that e ∘ g = g ∘ e = g for any group element g.

Source

pub fn jacobian_identity() -> Matrix<f64, Const<6>, Const<6>, ArrayStorage<f64, 6, 6>>

Get the identity matrix for Jacobians.

Returns the identity matrix in the appropriate dimension for Jacobian computations.

Source

pub fn new( translation: Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>, rotation: Unit<Quaternion<f64>>, ) -> SE3

Create a new SE3 element from translation and rotation.

§Arguments
  • translation - Translation vector [x, y, z]
  • rotation - Unit quaternion representing rotation
Source

pub fn from_translation_quaternion( translation: Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>, quaternion: Quaternion<f64>, ) -> SE3

Create SE3 from translation and raw quaternion (will be normalized).

Source

pub fn from_translation_euler( x: f64, y: f64, z: f64, roll: f64, pitch: f64, yaw: f64, ) -> SE3

Create SE3 from translation components and Euler angles.

Source

pub fn from_isometry(isometry: Isometry<f64, Unit<Quaternion<f64>>, 3>) -> SE3

Create SE3 directly from an Isometry3.

Source

pub fn from_translation_so3( translation: Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>, rotation: SO3, ) -> SE3

Create SE3 from SO3 and Vector3 components.

Source

pub fn translation( &self, ) -> Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>

Get the translation part as a Vector3.

Source

pub fn rotation_so3(&self) -> SO3

Get the rotation part as SO3.

Source

pub fn rotation_quaternion(&self) -> Unit<Quaternion<f64>>

Get the rotation part as a UnitQuaternion.

Source

pub fn isometry(&self) -> Isometry<f64, Unit<Quaternion<f64>>, 3>

Get as an Isometry3 (convenience method).

Source

pub fn matrix(&self) -> Matrix<f64, Const<4>, Const<4>, ArrayStorage<f64, 4, 4>>

Get the transformation matrix (4x4 homogeneous matrix).

Source

pub fn x(&self) -> f64

Get the x component of translation.

Source

pub fn y(&self) -> f64

Get the y component of translation.

Source

pub fn z(&self) -> f64

Get the z component of translation.

Source

pub fn coeffs(&self) -> [f64; 7]

Get coefficients as array [tx, ty, tz, qw, qx, qy, qz].

Trait Implementations§

Source§

impl Clone for SE3

Source§

fn clone(&self) -> SE3

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Display for SE3

Source§

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

Formats the value using the given formatter. Read more
Source§

impl LieGroup for SE3

Source§

fn inverse( &self, jacobian: Option<&mut <SE3 as LieGroup>::JacobianMatrix>, ) -> SE3

Get the inverse.

§Arguments
  • jacobian - Optional Jacobian matrix of the inverse wrt this.
§Notes
§Equation 170: Inverse of SE(3) matrix

M⁻¹ = [ Rᵀ -Rᵀt ] [ 0 1 ]

§Equation 176: Jacobian of inverse operation

J_M⁻¹_M = - [ R [t]ₓ R ] [ 0 R ]

Source§

fn compose( &self, other: &SE3, jacobian_self: Option<&mut <SE3 as LieGroup>::JacobianMatrix>, jacobian_other: Option<&mut <SE3 as LieGroup>::JacobianMatrix>, ) -> SE3

Composition of this and another SE3 element.

§Arguments
  • other - Another SE3 element.
  • jacobian_self - Optional Jacobian matrix of the composition wrt this.
  • jacobian_other - Optional Jacobian matrix of the composition wrt other.
§Notes
§Equation 171: Composition of SE(3) matrices

M_a M_b = [ R_aR_b R_at_b + t_a ] [ 0 1 ]

§Equation 177: Jacobian of the composition wrt self.

J_MaMb_Ma = [ R_bᵀ -R_bᵀ*[t_b]ₓ ] [ 0 R_bᵀ ]

§Equation 178: Jacobian of the composition wrt other.

J_MaMb_Mb = I_6

Source§

fn log( &self, jacobian: Option<&mut <SE3 as LieGroup>::JacobianMatrix>, ) -> <SE3 as LieGroup>::TangentVector

Get the SE3 corresponding Lie algebra element in vector form.

§Arguments
  • jacobian - Optional Jacobian matrix of the tangent wrt to this.
§Notes
§Equation 173: SE(3) logarithmic map

τ = log(M) = [ V⁻¹(θ) t ] [ Log(R) ]

§Equation 174: V(θ) function for SE(3) Log/Exp maps

V(θ) = I + (1 - cos θ)/θ² [θ]ₓ + (θ - sin θ)/θ³ [θ]ₓ²

Source§

fn vee(&self) -> <SE3 as LieGroup>::TangentVector

Vee operator: log(g)^∨.

Maps a group element g ∈ G to its tangent vector log(g)^∨ ∈ 𝔤. For SE(3), this is the same as log().

Source§

fn is_approx(&self, other: &SE3, tolerance: f64) -> bool

Check if the element is approximately equal to another element.

§Arguments
  • other - The other element to compare with
  • tolerance - The tolerance for the comparison
Source§

const NAME: &'static str = "SE3"

Human-readable name for serialization and logging.
Source§

type TangentVector = SE3Tangent

The tangent space vector type
Source§

type JacobianMatrix = Matrix<f64, Const<6>, Const<6>, ArrayStorage<f64, 6, 6>>

The Jacobian matrix type
Source§

type LieAlgebra = Matrix<f64, Const<4>, Const<4>, ArrayStorage<f64, 4, 4>>

Associated Lie algebra type
Source§

fn act( &self, vector: &Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>, jacobian_self: Option<&mut <SE3 as LieGroup>::JacobianMatrix>, jacobian_vector: Option<&mut Matrix<f64, Const<3>, Const<3>, ArrayStorage<f64, 3, 3>>>, ) -> Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>

Act on a vector v: g ⊙ v. Read more
Source§

fn adjoint(&self) -> <SE3 as LieGroup>::JacobianMatrix

Adjoint matrix Ad(g). Read more
Source§

fn random() -> SE3

Generate a random element (useful for testing and initialization).
Source§

fn jacobian_identity() -> <SE3 as LieGroup>::JacobianMatrix

Get the identity matrix for Jacobians. Read more
Source§

fn zero_jacobian() -> <SE3 as LieGroup>::JacobianMatrix

Get a zero Jacobian matrix. Read more
Source§

fn normalize(&mut self)

Normalize/project the element to the manifold. Read more
Source§

fn is_valid(&self, tolerance: f64) -> bool

Check if the element is approximately on the manifold.
Source§

fn as_param_slice(&self) -> &[f64]

Returns the manifold parameters as a contiguous flat slice. Read more
Source§

fn as_param_slice_mut(&mut self) -> &mut [f64]

Mutably borrows the raw parameter storage for in-place retraction updates.
Source§

fn from_param_slice(s: &[f64]) -> SE3

Constructs from a raw parameter slice (same layout as as_param_slice).
Source§

fn right_plus( &self, tangent: &Self::TangentVector, jacobian_self: Option<&mut Self::JacobianMatrix>, jacobian_tangent: Option<&mut Self::JacobianMatrix>, ) -> Self

Right plus operation: g ⊞ φ = g ∘ exp(φ^∧). Read more
Source§

fn right_minus( &self, other: &Self, jacobian_self: Option<&mut Self::JacobianMatrix>, jacobian_other: Option<&mut Self::JacobianMatrix>, ) -> Self::TangentVector

Right minus operation: g₁ ⊟ g₂ = log(g₂⁻¹ ∘ g₁)^∨. Read more
Source§

fn left_plus( &self, tangent: &Self::TangentVector, jacobian_tangent: Option<&mut Self::JacobianMatrix>, jacobian_self: Option<&mut Self::JacobianMatrix>, ) -> Self

Left plus operation: φ ⊞ g = exp(φ^∧) ∘ g. Read more
Source§

fn left_minus( &self, other: &Self, jacobian_self: Option<&mut Self::JacobianMatrix>, jacobian_other: Option<&mut Self::JacobianMatrix>, ) -> Self::TangentVector

Left minus operation: g₁ ⊟ g₂ = log(g₁ ∘ g₂⁻¹)^∨. Read more
Source§

fn plus( &self, tangent: &Self::TangentVector, jacobian_self: Option<&mut Self::JacobianMatrix>, jacobian_tangent: Option<&mut Self::JacobianMatrix>, ) -> Self

Convenience method for right_plus. Equivalent to g ⊞ φ.
Source§

fn minus( &self, other: &Self, jacobian_self: Option<&mut Self::JacobianMatrix>, jacobian_other: Option<&mut Self::JacobianMatrix>, ) -> Self::TangentVector

Convenience method for right_minus. Equivalent to g₁ ⊟ g₂.
Source§

fn between( &self, other: &Self, jacobian_self: Option<&mut Self::JacobianMatrix>, jacobian_other: Option<&mut Self::JacobianMatrix>, ) -> Self

Compute g₁⁻¹ ∘ g₂ (relative transformation). Read more
Source§

fn tangent_dim(&self) -> usize

Get the dimension of the tangent space for this manifold element. Read more
Source§

impl PartialEq for SE3

Source§

fn eq(&self, other: &SE3) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl RerunConvert3D for SE3

Available on crate feature visualization only.
Source§

fn to_rerun_transform(&self) -> Transform3D

Convert this SE3 pose to a Rerun Transform3D (translation + rotation).
Source§

fn to_rerun_vec3d(&self) -> Vec3D

Extract the translation component as a Rerun Vec3D.
Source§

fn to_rerun_points3d(&self) -> Points3D

Convert this SE3 pose to a single point in Rerun Points3D format.
Source§

fn to_rerun_arrows3d(&self) -> Arrows3D

Convert this SE3 pose to coordinate frame arrows in Rerun. Read more
Source§

impl StructuralPartialEq for SE3

Source§

impl Tangent<SE3> for SE3Tangent

Source§

const DIM: usize = 6

Dimension of the tangent space

Source§

fn exp(&self, jacobian: Option<&mut <SE3 as LieGroup>::JacobianMatrix>) -> SE3

Get the SE3 element.

§Arguments
  • tangent - Tangent vector [rho, theta]
  • jacobian - Optional Jacobian matrix of the SE3 element wrt this.
§Notes
§Equation 172: SE(3) exponential map

M = exp(τ) = [ R(θ) t(ρ) ] [ 0 1 ]

Source§

fn right_jacobian(&self) -> <SE3 as LieGroup>::JacobianMatrix

Right Jacobian Jr.

Computes the right Jacobian matrix such that for small δφ: exp((φ + δφ)^∧) ≈ exp(φ^∧) ∘ exp((Jr δφ)^∧)

For SE(3), this involves computing Jacobians for both translation and rotation parts.

§Returns

The right Jacobian matrix (6x6)

Source§

fn left_jacobian(&self) -> <SE3 as LieGroup>::JacobianMatrix

Left Jacobian Jl.

Computes the left Jacobian matrix such that for small δφ: exp((φ + δφ)^∧) ≈ exp((Jl δφ)^∧) ∘ exp(φ^∧)

Following manif conventions for SE(3) left Jacobian computation.

§Returns

The left Jacobian matrix (6x6)

Source§

fn right_jacobian_inv(&self) -> <SE3 as LieGroup>::JacobianMatrix

Inverse of right Jacobian Jr⁻¹.

Computes the inverse of the right Jacobian. This is used for computing perturbations and derivatives.

§Numerical Conditioning Warning

This 6×6 Jacobian inverse inherits SO(3) conditioning issues plus scale effects.

Sources of numerical error:

  • Embedded SO(3) rotation: (1 + cos θ) / (2θ sin θ) singularity
  • Q-block coupling: rotation errors propagate to translation
  • Scale amplification: large translations increase absolute error

Expected Precision:

  • Small rotations (θ < 0.01): Jr * Jr⁻¹ ≈ I within ~1e-6
  • Moderate rotations (θ < 0.1): Jr * Jr⁻¹ ≈ I within ~1e-4
  • Larger rotations: Jr * Jr⁻¹ ≈ I within ~0.01

This is a fundamental mathematical limitation consistent with production SLAM libraries. See module documentation for references.

§Returns

The inverse right Jacobian matrix (6x6)

Source§

fn left_jacobian_inv(&self) -> <SE3 as LieGroup>::JacobianMatrix

Inverse of left Jacobian Jl⁻¹.

Computes the inverse of the left Jacobian following manif conventions.

§Numerical Conditioning Warning

This 6×6 Jacobian inverse has the same conditioning issues as the right Jacobian inverse.

Sources of numerical error:

  • Embedded SO(3) rotation: (1 + cos θ) / (2θ sin θ) singularity
  • Q-block coupling: rotation errors propagate to translation
  • Scale amplification: large translations increase absolute error

Expected Precision: Same as right Jacobian inverse (see above).

This is a fundamental mathematical limitation consistent with production SLAM libraries. See module documentation for references.

§Returns

The inverse left Jacobian matrix (6x6)

Source§

fn hat(&self) -> <SE3 as LieGroup>::LieAlgebra

Hat operator: φ^∧ (vector to matrix).

Converts the SE(3) tangent vector to its 4x4 matrix representation in the Lie algebra. Following manif conventions, the structure is: [ theta_× rho ] [ 0 0 ] where theta_× is the skew-symmetric matrix of the rotational part.

§Returns

The 4x4 matrix representation in the SE(3) Lie algebra

Source§

fn zero() -> <SE3 as LieGroup>::TangentVector

Zero tangent vector.

Returns the zero element of the SE(3) tangent space.

§Returns

A 6-dimensional zero vector

Source§

fn random() -> <SE3 as LieGroup>::TangentVector

Random tangent vector (useful for testing).

Generates a random tangent vector with reasonable bounds. Translation components are in [-1, 1] and rotation components in [-0.1, 0.1].

§Returns

A random 6-dimensional tangent vector

Source§

fn is_zero(&self, tolerance: f64) -> bool

Check if the tangent vector is approximately zero.

Compares the norm of the tangent vector to the given tolerance.

§Arguments
  • tolerance - Tolerance for zero comparison
§Returns

True if the norm is below the tolerance

Source§

fn normalize(&mut self)

Normalize the tangent vector to unit norm.

Modifies this tangent vector to have unit norm. If the vector is near zero, it remains unchanged.

Source§

fn normalized(&self) -> <SE3 as LieGroup>::TangentVector

Return a unit tangent vector in the same direction.

Returns a new tangent vector with unit norm in the same direction. If the original vector is near zero, returns zero.

§Returns

A normalized copy of the tangent vector

Source§

fn small_adj(&self) -> <SE3 as LieGroup>::JacobianMatrix

Small adjoint matrix for SE(3).

For SE(3), the small adjoint matrix has the structure: [ Omega V ] [ 0 Omega ] where Omega is the skew-symmetric matrix of the angular part and V is the skew-symmetric matrix of the linear part.

Source§

fn lie_bracket(&self, other: &SE3Tangent) -> <SE3 as LieGroup>::TangentVector

Lie bracket for SE(3).

Computes the Lie bracket [this, other] = this.small_adj() * other.

Source§

fn is_approx(&self, other: &SE3Tangent, tolerance: f64) -> bool

Check if this tangent vector is approximately equal to another.

§Arguments
  • other - The other tangent vector to compare with
  • tolerance - The tolerance for the comparison
Source§

fn generator(&self, i: usize) -> <SE3 as LieGroup>::LieAlgebra

Get the ith generator of the SE(3) Lie algebra.

§Arguments
  • i - Index of the generator (0-5 for SE(3))
§Returns

The generator matrix

Source§

fn as_slice(&self) -> &[f64]

Borrows the raw tangent data as a flat slice. Zero allocation.
Source§

fn from_slice(s: &[f64]) -> SE3Tangent

Constructs from a raw slice (same layout as as_slice).
Source§

fn is_dynamic() -> bool

Whether this tangent type has dynamic (runtime-determined) dimension. Read more

Auto Trait Implementations§

§

impl Freeze for SE3

§

impl RefUnwindSafe for SE3

§

impl Send for SE3

§

impl Sync for SE3

§

impl Unpin for SE3

§

impl UnsafeUnpin for SE3

§

impl UnwindSafe for SE3

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> ErrorLogging for T
where T: Display,

Source§

fn log(self) -> Self

Log the error with tracing::error and return self for chaining. Read more
Source§

fn log_with_source<E: Debug>(self, source_error: E) -> Self

Log the error with an additional source error for debugging context. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.