Struct SourceCode 

pub struct SourceCode<'src> { /* private fields */ }

A structure that describes some YARA source code.

This structure contains a &str pointing to the code itself, and an optional origin that tells where the source code came from. The most common use for origin is indicating the path of the file from where the source code was obtained, but it can contain any arbitrary string. This string, if provided, will appear in error messages. For example, in this error message origin was set to some_file.yar:

error: syntax error
 --> some_file.yar:4:17
  |
4 | ... more details

Example

use yara_x::SourceCode;
let src = SourceCode::from("rule test { condition: true }").with_origin("some_file.yar");

Implementations

impl<'src> SourceCode<'src>

pub fn with_origin<S: Into<String>>(self, origin: S) -> Self

Sets a string that describes the origin of the source code.

This is usually the path of the file that contained the source code, but it can be an arbitrary string. The origin appears in error and warning messages.

Trait Implementations

impl<'src> Clone for SourceCode<'src>

fn clone(&self) -> SourceCode<'src>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for SourceCode<'src>

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

Formats the value using the given formatter.

impl<'src> From<&'src [u8]> for SourceCode<'src>

fn from(src: &'src [u8]) -> Self

Creates a new SourceCode from a &[u8].

As src is not guaranteed to be a valid UTF-8 string, the parser will verify it and return an error if invalid UTF-8 characters are found.

impl<'src> From<&'src str> for SourceCode<'src>

fn from(src: &'src str) -> Self

Creates a new SourceCode from a &str.