Skip to main content

DiffOptions

Enum DiffOptions 

Source
pub enum DiffOptions {
    Typed {
        format: DiffFormat,
        whitespace: WhitespaceHandling,
    },
    Raw(String),
}
Expand description

Diff routine options passed via -doptions, shared by commands such as p4 diff, p4 diff2, p4 describe, and p4 annotate.

The structured (Typed) options split into two orthogonal dimensions — DiffFormat (output format) and WhitespaceHandling — each of which is internally mutually exclusive. All options are assembled with a DiffOptionsBuilder, whose mode type parameter tracks at compile time whether structured or raw options are being built; both builder states convert into this type via From, and command methods accept impl Into<DiffOptions> so a builder can be passed directly.

§Examples

use perforce_cli::cmd::{DiffOptions, DiffOptionsBuilder};

// `-dub`: unified format, ignore changes within whitespace
let opts = DiffOptions::from(
    DiffOptionsBuilder::unified(None).ignore_changes_within_whitespace(),
);

// `-dc3`: context format with 3 lines of context
let opts = DiffOptions::from(DiffOptionsBuilder::context(Some(3)));

// `-d-C 25`: pass `-C 25` straight to an external diff program
let opts = DiffOptions::from(DiffOptionsBuilder::raw("-C 25"));

Variants§

§

Typed

Structured diff options (the documented subset of the standard UNIX diff flags).

Fields

§format: DiffFormat
§

Raw(String)

Raw option string passed directly to the underlying diff routine (useful with an external diff program configured via P4DIFF).

Implementations§

Source§

impl DiffOptions

Source

pub fn format(&self) -> Option<DiffFormat>

Returns the selected output format, or None if this is a Raw value.

Source

pub fn whitespace_handling(&self) -> Option<WhitespaceHandling>

Returns the selected whitespace handling, or None if this is a Raw value.

Source

pub fn raw_str(&self) -> Option<&str>

Returns the raw option string, or None if this is a Typed value.

Source

pub fn inject_arg(&self, command: &mut Command)

Injects the -doptions argument into command.

If this is a Typed value with both the format and whitespace handling at their defaults, no -d argument is emitted.

Trait Implementations§

Source§

impl Clone for DiffOptions

Source§

fn clone(&self) -> Self

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 Debug for DiffOptions

Source§

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

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

impl Default for DiffOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for DiffOptions

Source§

impl From<DiffOptionsBuilder<DiffOptionsRawMode>> for DiffOptions

Source§

fn from(builder: DiffOptionsBuilder<DiffOptionsRawMode>) -> Self

Converts to this type from the input type.
Source§

impl From<DiffOptionsBuilder<DiffOptionsTypedMode>> for DiffOptions

Source§

fn from(builder: DiffOptionsBuilder<DiffOptionsTypedMode>) -> Self

Converts to this type from the input type.
Source§

impl From<String> for DiffOptions

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for DiffOptions

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DiffOptions

Auto Trait Implementations§

Blanket Implementations§

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> 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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.