Struct ObsString

pub struct ObsString { /* private fields */ }

String wrapper for OBS function calls.

ObsString provides safe interaction with OBS C API functions that require C-style strings. It wraps CString internally with convenient helper functions for converting between Rust strings and C-compatible strings.

Safety

• Any NUL byte in input strings is stripped during conversion to prevent panicking
• Memory is properly managed to prevent use-after-free and memory leaks
• Automatically handles conversion between Rust’s UTF-8 strings and C’s NUL-terminated strings

Examples

use libobs_wrapper::utils::ObsString;

// Create an ObsString from a Rust string
let obs_string = ObsString::new("Hello, OBS!");

// Use in OBS API calls
unsafe {
    let ptr = obs_string.as_ptr();
    // Pass ptr.0 to OBS functions
}

Implementations

impl ObsString

pub fn new<S: AsRef<str>>(s: S) -> Self

Creates a new ObsString from a string slice.

Any NUL bytes in the input are automatically stripped to prevent panicking when converting to a C string.

Examples

use libobs_wrapper::utils::ObsString;

let obs_string = ObsString::new("source_name");

pub fn as_ptr(&self) -> Sendable<*const c_char>

Returns a pointer to the underlying C string along with sendable wrapper.

The returned pointer is suitable for passing to OBS C API functions.

Examples

use libobs_wrapper::utils::ObsString;

let obs_string = ObsString::new("source_name");
let ptr = obs_string.as_ptr();

// Use ptr.0 in OBS API calls

Trait Implementations

impl Clone for ObsString

fn clone(&self) -> ObsString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObsString

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

Formats the value using the given formatter.

impl Default for ObsString

fn default() -> ObsString

Returns the “default value” for a type.

impl From<&str> for ObsString

fn from(value: &str) -> Self

Creates an ObsString from a string slice.

Examples

use libobs_wrapper::utils::ObsString;

let obs_string: ObsString = "Hello".into();

impl From<String> for ObsString

fn from(value: String) -> Self

Creates an ObsString from a String.

Examples

use libobs_wrapper::utils::ObsString;

let s = String::from("Hello");
let obs_string: ObsString = s.into();

impl From<Vec<u8>> for ObsString

fn from(value: Vec<u8>) -> Self

Creates an ObsString from a vector of bytes.

Any NUL bytes in the input are automatically filtered out.

Examples

use libobs_wrapper::utils::ObsString;

let bytes = b"Hello".to_vec();
let obs_string: ObsString = bytes.into();

impl Into<ObsString> for ObsAudioEncoderType

fn into(self) -> ObsString

Converts this type into the (usually inferred) input type.

impl Into<ObsString> for ObsPath

fn into(self) -> ObsString

Converts this type into the (usually inferred) input type.

impl Into<ObsString> for ObsVideoEncoderType

fn into(self) -> ObsString

Converts this type into the (usually inferred) input type.

impl Ord for ObsString

fn cmp(&self, other: &ObsString) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ObsString

fn eq(&self, other: &ObsString) -> bool

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

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 PartialOrd for ObsString

fn partial_cmp(&self, other: &ObsString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ToString for ObsString

fn to_string(&self) -> String

Converts the ObsString back to a Rust String.

Examples

use libobs_wrapper::utils::ObsString;

let obs_string = ObsString::new("Hello");
assert_eq!(obs_string.to_string(), "Hello");

impl Eq for ObsString

impl StructuralPartialEq for ObsString