DirectiveLine in compiletest::directives::line - Rust
Description: The (partly) broken-down contents of a line containing a test directive, which `iter_directives` passes to its callback function.

Skip to main content

## DirectiveLine

# Struct DirectiveLine

Source

    pub(crate) struct DirectiveLine<'a> {
        pub(crate) file_path: &'a Utf8Path,
        pub(crate) line_number: LineNumber,
        pub(crate) revision: Option<&'a str>,
        raw_directive: &'a str,
        pub(crate) name: &'a str,
    }

Expand description

The (partly) broken-down contents of a line containing a test directive, which `iter_directives` passes to its callback function.

For example:

    //@ compile-flags: -O
        ^^^^^^^^^^^^^^^^^ raw_directive
        ^^^^^^^^^^^^^     name

    //@ [foo] compile-flags: -O
         ^^^                    revision
              ^^^^^^^^^^^^^^^^^ raw_directive
              ^^^^^^^^^^^^^     name

## Fields§

§`file_path: &'a Utf8Path`

Path of the file containing this line.

Mostly used for diagnostics, but some directives (e.g. `//@ pp-exact`) also use it to compute a value based on the filename.

§`line_number: LineNumber`§`revision: Option<&'a str>`

Some test directives start with a revision name in square brackets (e.g. `[foo]`), and only apply to that revision of the test. If present, this field contains the revision name (e.g. `foo`).

§`raw_directive: &'a str`

The main part of the directive, after removing the comment prefix and the optional revision specifier.

This is “raw” because the directive’s name and colon-separated value (if present) have not yet been extracted or checked.

§`name: &'a str`

Name of the directive.

Invariant: `self.raw_directive.starts_with(self.name)`

## Implementations§

Source§

### impl<'ln> DirectiveLine<'ln>

Source

#### pub(crate) fn applies_to_test_revision( &self, test_revision: Option<&str>, ) -> bool

Source

#### fn rest_after_separator(&self, separator: u8) -> Option<&'ln str>

Helper method used by `value_after_colon` and `remark_after_space`. Don’t call this directly.

Source

#### pub(crate) fn value_after_colon(&self) -> Option<&'ln str>

If this directive uses `name: value` syntax, returns the part after the colon character.

Source

#### pub(crate) fn remark_after_space(&self) -> Option<&'ln str>

If this directive uses `name remark` syntax, returns the part after the separating space.

Source

#### pub(crate) fn display(&self) -> impl Display

Allows callers to print `raw_directive` if necessary, without accessing the field directly.

## Auto Trait Implementations§

§

### impl<'a> Freeze for DirectiveLine<'a>

§

### impl<'a> RefUnwindSafe for DirectiveLine<'a>

§

### impl<'a> Send for DirectiveLine<'a>

§

### impl<'a> Sync for DirectiveLine<'a>

§

### impl<'a> Unpin for DirectiveLine<'a>

§

### impl<'a> UnsafeUnpin for DirectiveLine<'a>

§

### impl<'a> UnwindSafe for DirectiveLine<'a>

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

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

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

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

#### 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
§

### impl<T> Pointable for T

§

#### const ALIGN: usize

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
§

### impl<T> WithSubscriber for T

§

#### 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
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 72 bytes