libspelling 0.5.0

Rust bindings for libspelling
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::ffi;
use glib::{prelude::*, translate::*};

glib::wrapper! {
    #[doc(alias = "SpellingLanguage")]
    pub struct Language(Object<ffi::SpellingLanguage, ffi::SpellingLanguageClass>);

    match fn {
        type_ => || ffi::spelling_language_get_type(),
    }
}

impl Language {
    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`Language`] objects.
    ///
    /// This method returns an instance of [`LanguageBuilder`](crate::builders::LanguageBuilder) which can be used to create [`Language`] objects.
    pub fn builder() -> LanguageBuilder {
        LanguageBuilder::new()
    }

    #[doc(alias = "spelling_language_get_code")]
    #[doc(alias = "get_code")]
    pub fn code(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::spelling_language_get_code(self.to_glib_none().0)) }
    }

    #[doc(alias = "spelling_language_get_group")]
    #[doc(alias = "get_group")]
    pub fn group(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::spelling_language_get_group(self.to_glib_none().0)) }
    }

    #[doc(alias = "spelling_language_get_name")]
    #[doc(alias = "get_name")]
    pub fn name(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::spelling_language_get_name(self.to_glib_none().0)) }
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`Language`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct LanguageBuilder {
    builder: glib::object::ObjectBuilder<'static, Language>,
}

impl LanguageBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    pub fn code(self, code: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("code", code.into()),
        }
    }

    pub fn group(self, group: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("group", group.into()),
        }
    }

    pub fn name(self, name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("name", name.into()),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`Language`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> Language {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}