Skip to main content

Source

Struct Source 

Source
pub struct Source {
    pub name: String,
    pub address: SourceAddress,
}
Expand description

Represents an NDI source discovered on the network.

Sources contain a human-readable name and network address. The name typically includes the machine name and source name (e.g., “MACHINE (Source)”).

§Examples

use grafton_ndi::{Source, SourceAddress};

let source = Source {
    name: "LAPTOP (Camera 1)".to_string(),
    address: SourceAddress::Ip("192.168.1.100:5960".to_string()),
};

println!("Source: {}", source); // Displays: LAPTOP (Camera 1)@192.168.1.100:5960

Fields§

§name: String

The NDI source name (e.g., “MACHINE (Source Name)”).

§address: SourceAddress

The network address for connecting to this source.

Implementations§

Source§

impl Source

Source

pub fn matches_host(&self, host: &str) -> bool

Check if this source matches a given host or IP address.

This method checks both the source name and address for a match, making it easy to find sources by hostname or IP.

§Arguments
  • host - The hostname or IP address to match against
§Examples
use grafton_ndi::{Source, SourceAddress};

let source = Source {
    name: "CAMERA1 (Chan1, 192.168.0.107)".to_string(),
    address: SourceAddress::Ip("192.168.0.107:5960".to_string()),
};

assert!(source.matches_host("192.168.0.107"));
assert!(source.matches_host("CAMERA1"));
assert!(!source.matches_host("192.168.1.1"));
Source

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

Extract the IP address from this source if available.

For IP-based sources, this returns the IP portion without the port. For URL-based sources, this extracts the hostname portion.

§Returns

Some(ip) if an IP or hostname is found, None otherwise.

§Examples
use grafton_ndi::{Source, SourceAddress};

let source = Source {
    name: "CAMERA1".to_string(),
    address: SourceAddress::Ip("192.168.1.100:5960".to_string()),
};

assert_eq!(source.ip_address(), Some("192.168.1.100"));
Source

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

Extract the hostname or IP without port.

This is an alias for ip_address() for better API discoverability.

§Examples
use grafton_ndi::{Source, SourceAddress};

let source = Source {
    name: "CAMERA1".to_string(),
    address: SourceAddress::Ip("192.168.1.100:5960".to_string()),
};

assert_eq!(source.host(), Some("192.168.1.100"));

Trait Implementations§

Source§

impl Clone for Source

Source§

fn clone(&self) -> Source

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Source

Source§

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

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

impl Default for Source

Source§

fn default() -> Source

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

impl Display for Source

Source§

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

Formats the value using the given formatter. Read more

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.