Struct rhyoea::debug::messenger::Message

pub struct Message { /* fields omitted */ }

The Message type. See the module level documentation for more

Methods

impl Message

#[must_use] pub fn id_name(&self) -> String

Indicating what triggered the message. For validation layers, this string may contain the valid usage ID (VUID) string identifier that will help identify the specific portion of the specification that the layer believes was violated. Re

Example

use rhyoea::instance::{application::Application, Instance};
use rhyoea::extends::{Extensions, Extends, Filtrable, Layers};
use rhyoea::debug::messenger::{Messenger, Message};

let application = Application::default();

let extensions = Extensions::available()
    .into_iter()
    .filter(Messenger::require_extension)
    .collect();

let layers: Vec<_> = Layers::available()
    .into_iter()
    .filter(Messenger::require_layer)
    .collect();

let instance = Instance::new(&application, extensions, layers).unwrap();
let _ = Messenger::default(instance, |_, _, message| println!("{}", message.id_name()) );

#[must_use] pub const fn id_number(&self) -> i32

Indicates the unique number of this message (if it is non-zero). If this message was triggered by a validation layer, it will contain a unique numeric valid usage ID for the validation warning or error that occurred. Use this number in a table lookup to determine the location in the Vulkan specification that the validation layers believe you may have violated.

Example

use rhyoea::instance::{application::Application, Instance};
use rhyoea::extends::{Extensions, Extends, Filtrable, Layers};
use rhyoea::debug::messenger::{Messenger, Message};

let application = Application::default();

let extensions = Extensions::available()
    .into_iter()
    .filter(Messenger::require_extension)
    .collect();

let layers: Vec<_> = Layers::available()
    .into_iter()
    .filter(Messenger::suggest_layer)
    .collect();

let instance = Instance::new(&application, extensions, layers).unwrap();
let _ = Messenger::default(instance, |_, _, message| println!("{}", message.id_number() ) );

#[must_use] pub fn description(&self) -> String

Indicates the specifics of the message.

Example

use rhyoea::instance::{application::Application, Instance};
use rhyoea::extends::{Extensions, Extends, Filtrable, Layers};
use rhyoea::debug::messenger::{Messenger, Message};

let application = Application::default();

let extensions = Extensions::available()
    .into_iter()
    .filter(Messenger::require_extension)
    .collect();

let layers: Vec<_> = Layers::available()
    .into_iter()
    .filter(Messenger::suggest_layer)
    .collect();

let instance = Instance::new(&application, extensions, layers).unwrap();
let _ = Messenger::default(instance, |_, _, message| println!("{}", message.description() ) );

#[must_use] pub fn objects(&self) -> Vec<Object>

Contains the information about any objects that can be easily associated with the message

Example

use rhyoea::instance::{application::Application, Instance};
use rhyoea::extends::{Extensions, Extends, Filtrable, Layers};
use rhyoea::debug::messenger::{Messenger, Message};

let application = Application::default();

let extensions = Extensions::available()
    .into_iter()
    .filter(Messenger::require_extension)
    .collect();

let layers: Vec<_> = Layers::available()
    .into_iter()
    .filter(Messenger::suggest_layer)
    .collect();

let instance = Instance::new(&application, extensions, layers).unwrap();
let _ = Messenger::default(instance, |_, _, message| println!("{:#?}", message.objects() ) );

#[must_use] pub fn queue_labels(&self) -> Vec<Label>

Example

use rhyoea::instance::{application::Application, Instance};
use rhyoea::extends::{Extensions, Extends, Filtrable, Layers};
use rhyoea::debug::messenger::{Messenger, Message};

let application = Application::default();

let extensions = Extensions::available()
    .into_iter()
    .filter(Messenger::require_extension)
    .collect();

let layers: Vec<_> = Layers::available()
    .into_iter()
    .filter(Messenger::suggest_layer)
    .collect();

let instance = Instance::new(&application, extensions, layers).unwrap();
let _ = Messenger::default(instance, |_, _, message| println!("{:#?}", message.queue_labels() ) );

#[must_use] pub fn command_buffer_labels(&self) -> Vec<Label>

Example

use rhyoea::instance::{application::Application, version::Version, application::Engine, Instance};
use rhyoea::extends::{Extensions, Extends, Filtrable, Layers};
use rhyoea::debug::messenger::{Messenger, Message};

let application_version = Version::new(1, 0, 0);
let engine = Engine::default();

let application = Application::new("qux".to_string(), application_version, engine).unwrap();

let extensions = Extensions::available()
    .into_iter()
    .filter(Messenger::require_extension)
    .collect();

let layers: Vec<_> = Layers::available()
    .into_iter()
    .filter(Messenger::suggest_layer)
    .collect();

let instance = Instance::new(&application, extensions, layers).unwrap();
let _ = Messenger::default(instance, |_, _, message| println!("{:#?}", message.command_buffer_labels() ) );

pub fn default_callback(
    message_severity: MessageSeverity,
    message_type: MessageType,
    message: Self
)

Example

use rhyoea::instance::{application::Application, Instance};
use rhyoea::extends::{Extensions, Extends, Filtrable, Layers};
use rhyoea::debug::messenger::{Messenger, Message};

let application = Application::default();

let extensions = Extensions::available()
    .into_iter()
    .filter(Messenger::require_extension)
    .collect();

let layers: Vec<_> = Layers::available()
    .into_iter()
    .filter(Messenger::suggest_layer)
    .collect();

let instance = Instance::new(&application, extensions, layers).unwrap();
assert!(Messenger::default(instance, Message::default_callback).is_ok());

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Message

impl Debug for Message

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

Formats the value using the given formatter.