Struct Signature

pub struct Signature<'a> { /* private fields */ }

A string encoding information about the code being profiled for Godot’s built-in profiler.

The string should be in the form of {file}::{line_number}::{tag}, where tag is an identifier of the code, usually be the name of the method. None of the substrings should contain ::.

To create a Signature in the correct form, see Signature::new() or profile_sig!. To create a Signature from an existing CStr or CString, see Signature::from_raw() and Signature::from_raw_owned().

Implementations

impl<'a> Signature<'a>

pub const fn from_raw(sig: &'a CStr) -> Self

Creates a Signature from a CStr in the specified format. The format is not checked.

Adding profiling data using an invalid Signature may cause incorrect information to show up in the editor.

pub unsafe fn from_bytes_with_nul_unchecked(bytes: &'a [u8]) -> Self

Creates a Signature from a NUL-terminated byte slice, containing a string in the specified format. Neither the format nor whether the slice is correctly NUL-terminated is checked.

This is a convenience method for Signature::from_raw(CStr::from_bytes_with_nul_unchecked(bytes)).

Adding profiling data using an invalid Signature may cause incorrect information to show up in the editor.

Safety

This function will cast the provided bytes to a CStr wrapper without performing any sanity checks. The provided slice must be nul-terminated and not contain any interior nul bytes.

pub fn borrow(&self) -> Signature<'_>

Create a borrowed version of self for repeated use with add_data() or profile().

pub fn add_data(&self, time: Duration)

Add a data point to Godot’s built-in profiler using this signature.

See the free function profiler::add_data().

pub fn profile<F, R>(&self, f: F) -> R

where F: FnOnce() -> R,

Times a closure and adds the measured time to Godot’s built-in profiler with this signature, and then returns it’s return value.

See the free function profiler::profile().

impl Signature<'static>

pub fn new(file: &str, line: u32, tag: &str) -> Self

Creates a Signature in the correct form using the given variables. The format is checked at runtime.

Panics

If file or tag contain :: or NUL-bytes.

pub const fn from_raw_owned(sig: CString) -> Self

Creates a Signature from an owned CString in the specified format. The format is not checked.

Adding profiling data using an invalid Signature may cause incorrect information to show up in the editor.

Trait Implementations

impl<'a> Clone for Signature<'a>

fn clone(&self) -> Signature<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Signature<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Signature<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Signature<'a>

fn eq(&self, other: &Signature<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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<'a> Eq for Signature<'a>

impl<'a> StructuralPartialEq for Signature<'a>