Libappstream Rs

https://world.pages.gitlab.gnome.org/Rust/libappstream-rs
Admin
Libappstream Rs provides safe Rust bindings for AppStream, enabling Rust applications to access and...
Tokens:1,149,654
Snippets:8,141
Trust Score:10
Update:2 days ago
Show doc for...
Tokens:
Raw
### fn pkgname(&self) -> Option<GString>

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/prelude/trait.ComponentExt.html

Returns the first package name of the list of packages that need to be installed for this component to be present on the system. Since most components consist of only one package, this is safe to use for about 90% of all cases. However, to support a component fully, use pkgnames() for getting all packages that need to be installed, and use this method only to e.g. get the main package to perform a quick 'is it installed?' check.

```APIDOC
## fn pkgname(&self) -> Option<GString>

### Description
Returns the first package name of the list of packages that need to be installed for this component to be present on the system. Since most components consist of only one package, this is safe to use for about 90% of all cases. However, to support a component fully, use pkgnames() for getting all packages that need to be installed, and use this method only to e.g. get the main package to perform a quick 'is it installed?' check.

### Method
pkgname

### Signature
`fn pkgname(&self) -> Option<GString>`

### Returns
- `Option<GString>` - The first package name, or `None` if not available.
```

--------------------------------

### pkgname

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/struct.Component.html

Get the first package name of the list of packages that need to be installed for this component to be present on the system. Since most components consist of only one package, this is safe to use for about 90% of all cases.

```APIDOC
## pkgname

### Description
Get the first package name of the list of packages that need to be installed for this component to be present on the system. Since most components consist of only one package, this is safe to use for about 90% of all cases.

### Method
fn pkgname(&self) -> Option<GString>

### Parameters
None

### Returns
- **Option<GString>** - The first package name, if any.
```

--------------------------------

### as_system_info_get_os_version

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the OS version.

```APIDOC
## as_system_info_get_os_version

### Description
Gets the OS version.

### Function
`as_system_info_get_os_version`

### Parameters
- `system_info` (AsSystemInfo*) - The system info object.

### Returns
The OS version.
```

--------------------------------

### as_system_info_get_type

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the GType for AsSystemInfo.

```APIDOC
## as_system_info_get_type

### Description
Gets the GType for AsSystemInfo.

### Function
`as_system_info_get_type`

### Parameters
None.

### Returns
The GType for AsSystemInfo.
```

--------------------------------

### as_release_get_description

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the description of a release.

```APIDOC
## as_release_get_description

### Description
Gets the description of a release.

### Function Signature
`as_release_get_description`

### Parameters
- **release** (AsRelease) - The release object.

### Returns
- **string** - The description.

```

--------------------------------

### as_pool_get_components_by_launchable

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets components by launchable.

```APIDOC
## as_pool_get_components_by_launchable

### Description
Gets components by launchable.

### Function Signature
`as_pool_get_components_by_launchable`

### Parameters
- **pool** (pointer) - The pool object.
- **launchable** (string) - The launchable value.

### Returns
- **components** (list) - The list of components.
```

--------------------------------

### as_pool_get_components_by_extends

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets components by extends.

```APIDOC
## as_pool_get_components_by_extends

### Description
Gets components by extends.

### Function Signature
`as_pool_get_components_by_extends`

### Parameters
- **pool** (pointer) - The pool object.
- **extends** (string) - The extends value.

### Returns
- **components** (list) - The list of components.
```

--------------------------------

### as_pool_get_components_by_kind

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets components by kind.

```APIDOC
## as_pool_get_components_by_kind

### Description
Gets components by kind.

### Function Signature
`as_pool_get_components_by_kind`

### Parameters
- **pool** (pointer) - The pool object.
- **kind** (enum) - The component kind.

### Returns
- **components** (list) - The list of components.
```

--------------------------------

### as_system_info_new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Creates a new AsSystemInfo instance.

```APIDOC
## as_system_info_new

### Description
Creates a new AsSystemInfo instance.

### Function
`as_system_info_new`

### Parameters
None.

### Returns
A new AsSystemInfo instance.
```

--------------------------------

### ReviewExt::flags

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/src/libappstream/auto/review.rs.html

Gets any flags set on the review, for example if the user has already voted or wrote the review.

```APIDOC
## ReviewExt::flags

### Description
Gets any flags set on the review, for example if the user has already voted on the review or if the user wrote the review themselves.

### Method
`fn flags(&self) -> ReviewFlags`

### Parameters
None.

### Returns
- **ReviewFlags** - A ReviewFlags value, e.g., ReviewFlags::SELF.
```

--------------------------------

### Video::new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/struct.Video.html

Creates a new Video instance.

```APIDOC
## Video::new

### Description
Creates a new `Video` instance.

### Method
`pub fn new() -> Video`

### Returns
A new `Video` object.

```

--------------------------------

### fn flags(&self) -> ReviewFlags

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/prelude/trait.ReviewExt.html

Gets any flags set on the review, for example if the user has already voted on the review or if the user wrote the review themselves.

```APIDOC
## fn flags(&self) -> ReviewFlags

### Description
Gets any flags set on the review, for example if the user has already voted on the review or if the user wrote the review themselves.

### Method
flags

### Signature
`fn flags(&self) -> ReviewFlags`

### Parameters
None

### Returns
- **ReviewFlags** - A `ReviewFlags` value, e.g. `ReviewFlags::SELF`.
```

--------------------------------

### ReleaseList::new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/struct.ReleaseList.html

Creates a new ReleaseList instance.

```APIDOC
## ReleaseList::new

### Description
Creates a new `ReleaseList`.

### Method
`pub fn new() -> ReleaseList`

### Parameters
None

### Returns
A new `ReleaseList` instance.

```

--------------------------------

### as_agreement_get_sections

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/src/libappstream_sys/lib.rs.html

Gets all sections of an AsAgreement.

```APIDOC
## as_agreement_get_sections

### Description
Retrieves a GPtrArray containing all AsAgreementSection objects associated with the agreement.

### Function Signature
```rust
pub fn as_agreement_get_sections(agreement: *mut AsAgreement) -> *mut glib::GPtrArray;
```

### Parameters
- **agreement** (*mut AsAgreement) - Required - Pointer to the AsAgreement object.

### Return Value
- **\*mut glib::GPtrArray** - Pointer to a GPtrArray of AsAgreementSection pointers.
```

--------------------------------

### as_utils_install_metadata_file

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/fn.as_utils_install_metadata_file.html

Installs a metadata file to the specified location. This function is part of the libappstream_sys crate and is unsafe to call.

```APIDOC
## as_utils_install_metadata_file

### Description
Installs a metadata file to the specified location. This function is part of the libappstream_sys crate and is unsafe to call.

### Function Signature
```rust
pub unsafe extern "C" fn as_utils_install_metadata_file(
    location: AsMetadataLocation,
    filename: *const c_char,
    origin: *const c_char,
    destdir: *const c_char,
    error: *mut *mut GError,
) -> gboolean
```

### Parameters
- **location** (AsMetadataLocation) - The location where the metadata file should be installed.
- **filename** (*const c_char) - The name of the metadata file to install.
- **origin** (*const c_char) - The origin of the metadata file.
- **destdir** (*const c_char) - The destination directory for the installation.
- **error** (*mut *mut GError) - A pointer to a GError pointer for error reporting.

### Return Value
- **gboolean** - Returns TRUE on success, FALSE on failure.

### Safety
This function is unsafe because it uses raw pointers and may interact with the system in ways that require careful handling.
```

--------------------------------

### as_agreement_get_kind

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/src/libappstream_sys/lib.rs.html

Gets the kind of an AsAgreement.

```APIDOC
## as_agreement_get_kind

### Description
Retrieves the kind of the agreement (e.g., license, privacy policy).

### Function Signature
```rust
pub fn as_agreement_get_kind(agreement: *mut AsAgreement) -> AsAgreementKind;
```

### Parameters
- **agreement** (*mut AsAgreement) - Required - Pointer to the AsAgreement object.

### Return Value
- **AsAgreementKind** - The kind of the agreement.
```

--------------------------------

### as_component_get_recommends

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/src/libappstream_sys/lib.rs.html

Returns the list of recommended components.

```APIDOC
## as_component_get_recommends

### Description
Returns the list of recommended components.

### Function Signature
```rust
pub fn as_component_get_recommends(cpt: *mut AsComponent) -> *mut glib::GPtrArray;
```

### Parameters
- **cpt** (*mut AsComponent) - Required - Pointer to the AsComponent object.

### Returns
- **glib::GPtrArray*** - Pointer to a GPtrArray of AsComponent objects, or NULL if none.
```

--------------------------------

### as_suggested_new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Creates a new AsSuggested instance.

```APIDOC
## as_suggested_new

### Description
Creates a new AsSuggested instance.

### Function
`as_suggested_new`

### Parameters
None.

### Returns
A new AsSuggested instance.
```

--------------------------------

### version()

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/src/libappstream/auto/release.rs.html

Gets the release version.

```APIDOC
## version()

### Description
Gets the release version.

### Method
version()

### Returns
- **Option<glib::GString>** - String, or None for not set or invalid.

```

--------------------------------

### functions::utils_install_metadata_file

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/all.html

Installs a metadata file to the appropriate location.

```APIDOC
## functions::utils_install_metadata_file

### Description
Installs a metadata file to the appropriate location.

### Function Signature
`pub fn utils_install_metadata_file(source: &str, destination: &str) -> Result<(), Error>`

### Parameters
- **source** (`&str`) - The source file path.
- **destination** (`&str`) - The destination directory.

### Returns
- **Result<(), Error>** - `Ok(())` on success, `Err` on failure.

```

--------------------------------

### timestamp()

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/src/libappstream/auto/release.rs.html

Gets the release timestamp.

```APIDOC
## timestamp()

### Description
Gets the release timestamp.

### Method
timestamp()

### Returns
- **u64** - Timestamp, or 0 for unset.

```

--------------------------------

### as_system_info_new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/index.html

Creates a new system information object.

```APIDOC
## as_system_info_new

### Description
Creates a new system information object.

### Function Signature
`pub unsafe fn as_system_info_new() -> *mut AsSystemInfo`

### Parameters
None.

### Returns
- **AsSystemInfo*** - A pointer to the newly created object, or NULL on failure.

### Note
This is an unsafe FFI function.
```

--------------------------------

### as_release_url_kind_get_type

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/index.html

Gets the GType for AsReleaseUrlKind.

```APIDOC
## as_release_url_kind_get_type

### Description
Gets the GType for AsReleaseUrlKind.

### Function Signature
`fn as_release_url_kind_get_type()`

### Parameters
None.

### Returns
GType.
```

--------------------------------

### Context::new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/src/libappstream/auto/context.rs.html

Creates a new Context instance.

```APIDOC
## Context::new

### Description
Creates a new `Context` object.

### Method
`Context::new() -> Context`

### Returns
- `Context` - A new `Context` instance.

```

--------------------------------

### as_release_get_version

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/index.html

Gets the version of a release.

```APIDOC
## as_release_get_version

### Description
Gets the version of a release.

### Function
`as_release_get_version`

### Parameters
- `release` (pointer) - The AsRelease object.

### Returns
`gchar*` - The version string.
```

--------------------------------

### utils_install_metadata_file

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/functions/fn.utils_install_metadata_file.html

Installs an AppStream MetaInfo, AppStream Metadata Catalog or AppStream Icon tarball file to the right place on the filesystem. Note that this function does almost no validation and may guess missing values such as icon sizes and origin names.

```APIDOC
## Function utils_install_metadata_file

### Description
Installs an AppStream MetaInfo, AppStream Metadata Catalog or AppStream Icon tarball file to the right place on the filesystem. Please note that this function does almost no validation and may guess missing values such as icon sizes and origin names. Ensure your metadata is good before installing it.

### Signature
```rust
pub fn utils_install_metadata_file(
    location: MetadataLocation,
    filename: &str,
    origin: &str,
    destdir: &str,
) -> Result<(), Error>
```

### Parameters
- **location** (MetadataLocation) - Required - The `MetadataLocation`, e.g. `MetadataLocation::Cache`.
- **filename** (&str) - Required - The full path of the file to install.
- **origin** (&str) - Required - The origin to use for the installation, or `None`.
- **destdir** (&str) - Required - The destdir to use, or `None`.

### Returns
`Result<(), Error>` - Returns `Ok(())` on success, or an `Error` if installation fails.
```

--------------------------------

### as_release_get_url

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/index.html

Gets the URL of a release.

```APIDOC
## as_release_get_url

### Description
Gets the URL of a release.

### Function
`as_release_get_url`

### Parameters
- `release` (pointer) - The AsRelease object.

### Returns
`gchar*` - The URL string.
```

--------------------------------

### as_release_get_context

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/index.html

Gets the context of a release.

```APIDOC
## as_release_get_context

### Description
Gets the context of a release.

### Function
`as_release_get_context`

### Parameters
- `release` (pointer) - The AsRelease object.

### Returns
`gchar*` - The context string.
```

--------------------------------

### fn explanation(&self) -> Option<GString>

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/struct.ValidatorIssue.html

Get an extended explanation on this issue, or return None if none is available.

```APIDOC
## fn explanation(&self) -> Option<GString>

### Description
Get an extended explanation on this issue, or return `None` if none is available.

### Method
`explanation`

### Signature
`fn explanation(&self) -> Option<GString>`

### Parameters
- `self` - The ValidatorIssue instance.

### Returns
- `Option<GString>` - An optional extended explanation string.
```

--------------------------------

### as_component_get_supports

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/src/libappstream_sys/lib.rs.html

Returns the list of supported components.

```APIDOC
## as_component_get_supports

### Description
Returns the list of supported components.

### Function Signature
```rust
pub fn as_component_get_supports(cpt: *mut AsComponent) -> *mut glib::GPtrArray;
```

### Parameters
- **cpt** (*mut AsComponent) - Required - Pointer to the AsComponent object.

### Returns
- **glib::GPtrArray*** - Pointer to a GPtrArray of AsComponent objects, or NULL if none.
```

--------------------------------

### as_relation_item_kind_get_type

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/index.html

Gets the GType for AsRelationItemKind.

```APIDOC
## as_relation_item_kind_get_type

### Description
Gets the GType for AsRelationItemKind.

### Function Signature
`fn as_relation_item_kind_get_type()`

### Returns
- **GType** - The GType identifier.

```

--------------------------------

### as_validator_get_type

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the type of the validator.

```APIDOC
## as_validator_get_type

### Description
Gets the type of the validator.

### Function
`as_validator_get_type`

### Parameters
- **validator** (pointer) - The validator instance.

### Returns
- **integer** - The type of the validator.

```

--------------------------------

### as_component_get_suggested

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/src/libappstream_sys/lib.rs.html

Returns the list of suggested components.

```APIDOC
## as_component_get_suggested

### Description
Returns the list of suggested components.

### Function Signature
```rust
pub fn as_component_get_suggested(cpt: *mut AsComponent) -> *mut glib::GPtrArray;
```

### Parameters
- **cpt** (*mut AsComponent) - Required - Pointer to the AsComponent object.

### Returns
- **glib::GPtrArray*** - Pointer to a GPtrArray of AsComponent objects, or NULL if none.
```

--------------------------------

### Review::new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/struct.Review.html

Creates a new Review instance. This is the primary constructor for the Review struct.

```APIDOC
## Review::new

### Description
Creates a new `Review` instance.

### Method
`pub fn new() -> Review`

### Parameters
None.

### Returns
A new `Review` instance.

### Example
```rust
let review = Review::new();
```
```

--------------------------------

### as_system_info_get_gui_available

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Checks if a GUI is available.

```APIDOC
## as_system_info_get_gui_available

### Description
Checks if a GUI is available.

### Function
`as_system_info_get_gui_available`

### Parameters
- `system_info` (AsSystemInfo*) - The system info object.

### Returns
A boolean indicating GUI availability.
```

--------------------------------

### as_system_info_get_os_name

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the OS name.

```APIDOC
## as_system_info_get_os_name

### Description
Gets the OS name.

### Function
`as_system_info_get_os_name`

### Parameters
- `system_info` (AsSystemInfo*) - The system info object.

### Returns
The OS name.
```

--------------------------------

### as_provided_new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Creates a new AsProvided object.

```APIDOC
## as_provided_new

### Description
Creates a new AsProvided object.

### Function Signature
`as_provided_new() -> *mut AsProvided`

### Parameters
None

### Returns
- **pointer** (*mut AsProvided) - A pointer to the newly created object.
```

--------------------------------

### as_system_info_get_os_id

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the OS ID.

```APIDOC
## as_system_info_get_os_id

### Description
Gets the OS ID.

### Function
`as_system_info_get_os_id`

### Parameters
- `system_info` (AsSystemInfo*) - The system info object.

### Returns
The OS ID.
```

--------------------------------

### Launchable::new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/src/libappstream/auto/launchable.rs.html

Creates a new Launchable object.

```APIDOC
## Launchable::new

### Description
Creates a new `Launchable` object.

### Method
`Launchable::new() -> Launchable`

### Returns
A new `Launchable` instance.

```

--------------------------------

### as_system_info_get_modaliases

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the list of modaliases.

```APIDOC
## as_system_info_get_modaliases

### Description
Gets the list of modaliases.

### Function
`as_system_info_get_modaliases`

### Parameters
- `system_info` (AsSystemInfo*) - The system info object.

### Returns
A list of modaliases.
```

--------------------------------

### as_launchable_new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Creates a new AsLaunchable object.

```APIDOC
## as_launchable_new

### Description
Creates a new AsLaunchable object.

### Function Signature
`as_launchable_new() -> *mut AsLaunchable`

### Parameters
None.

### Return Value
Returns a pointer to the newly created AsLaunchable object.
```

--------------------------------

### as_system_info_get_kernel_version

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the kernel version.

```APIDOC
## as_system_info_get_kernel_version

### Description
Gets the kernel version.

### Function
`as_system_info_get_kernel_version`

### Parameters
- `system_info` (AsSystemInfo*) - The system info object.

### Returns
The kernel version.
```

--------------------------------

### as_system_info_get_kernel_name

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the kernel name.

```APIDOC
## as_system_info_get_kernel_name

### Description
Gets the kernel name.

### Function
`as_system_info_get_kernel_name`

### Parameters
- `system_info` (AsSystemInfo*) - The system info object.

### Returns
The kernel name.
```

--------------------------------

### fn videos(&self) -> Vec<Video>

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/prelude/trait.ScreenshotExt.html

Gets the videos for this screenshot. Only videos valid for the current language selection are returned. We return all sizes.

```APIDOC
## fn videos(&self) -> Vec<Video>

### Description
Gets the videos for this screenshot. Only videos valid for the current language selection are returned. We return all sizes.

### Method
videos

### Returns
- `Vec<Video>` - An array of videos.

```

--------------------------------

### as_system_info_error_get_type

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the GType for AsSystemInfoError.

```APIDOC
## as_system_info_error_get_type

### Description
Gets the GType for AsSystemInfoError.

### Function
`as_system_info_error_get_type`

### Parameters
None.

### Returns
The GType for AsSystemInfoError.
```

--------------------------------

### fn context(&self) -> Option<Context>

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/prelude/trait.ReleaseListExt.html

Gets the Context associated with these releases, if any.

```APIDOC
## fn context(&self) -> Option<Context>

### Description
Get the Context associated with these releases. This function may return None if no context is set.

### Method
context

### Parameters
None.

### Returns
The associated Context or None.
```

--------------------------------

### Provided::new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/struct.Provided.html

Creates a new Provided instance. This is the primary constructor for the Provided struct.

```APIDOC
## Provided::new

### Description
Creates a new `Provided` instance.

### Method
`pub fn new() -> Provided`

### Returns
A new `Provided` object.

### Example
```rust
let provided = Provided::new();
```
```

--------------------------------

### as_suggested_kind_get_type

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the GType for AsSuggestedKind.

```APIDOC
## as_suggested_kind_get_type

### Description
Gets the GType for AsSuggestedKind.

### Function
`as_suggested_kind_get_type`

### Parameters
None.

### Returns
The GType for AsSuggestedKind.
```

--------------------------------

### as_size_kind_get_type

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the GType for AsSizeKind.

```APIDOC
## as_size_kind_get_type

### Description
Gets the GType for AsSizeKind.

### Function Signature
`as_size_kind_get_type`

### Parameters
None.

### Returns
GType - The GType.
```

--------------------------------

### fn hint(&self) -> Option<GString>

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/struct.ValidatorIssue.html

Get a short context hint for this issue.

```APIDOC
## fn hint(&self) -> Option<GString>

### Description
Get a short context hint for this issue.

### Method
`hint`

### Signature
`fn hint(&self) -> Option<GString>`

### Parameters
- `self` - The ValidatorIssue instance.

### Returns
- `Option<GString>` - An optional short context hint string.
```

--------------------------------

### Release::new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/struct.Release.html

Creates a new Release instance. This is the primary constructor for the Release struct.

```APIDOC
## Release::new

### Description
Creates a new `Release` instance.

### Method
`pub fn new() -> Release`

### Parameters
None

### Returns
- `Release` - A new `Release` instance.

### Example
```rust
let release = Release::new();
```
```

--------------------------------

### as_screenshot_media_kind_get_type

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the GType for AsScreenshotMediaKind.

```APIDOC
## as_screenshot_media_kind_get_type

### Description
Gets the GType for AsScreenshotMediaKind.

### Function Signature
`as_screenshot_media_kind_get_type`

### Parameters
None.

### Returns
GType - The GType.
```

--------------------------------

### as_screenshot_kind_get_type

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the GType for AsScreenshotKind.

```APIDOC
## as_screenshot_kind_get_type

### Description
Gets the GType for AsScreenshotKind.

### Function Signature
`as_screenshot_kind_get_type`

### Parameters
None.

### Returns
GType - The GType.
```

--------------------------------

### as_provided_new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/fn.as_provided_new.html

Creates a new AsProvided instance. This function is unsafe and returns a raw pointer to the newly allocated AsProvided object.

```APIDOC
## as_provided_new

### Description
Creates a new AsProvided instance. This function is unsafe and returns a raw pointer to the newly allocated AsProvided object.

### Signature
```rust
pub unsafe extern "C" fn as_provided_new() -> *mut AsProvided
```

### Safety
This function is unsafe because it returns a raw pointer that must be properly managed by the caller.

### Returns
- **pointer** (*mut AsProvided) - A mutable pointer to the newly created AsProvided instance.
```

--------------------------------

### as_system_info_get_os_homepage

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/fn.as_system_info_get_os_homepage.html

Retrieves the OS homepage from the given system information. This is an unsafe function that must be called with a valid mutable pointer to an AsSystemInfo.

```APIDOC
## Function as_system_info_get_os_homepage

### Description
Retrieves the OS homepage from the given system information. This is an unsafe function that must be called with a valid mutable pointer to an AsSystemInfo.

### Signature
```rust
pub unsafe extern "C" fn as_system_info_get_os_homepage(
    sysinfo: *mut AsSystemInfo,
) -> *const c_char
```

### Parameters
- **sysinfo** (*mut AsSystemInfo) - Required - A mutable pointer to the system information object.

### Returns
- ***const c_char** - A pointer to a constant C string containing the OS homepage, or NULL if not available.

### Safety
This function is unsafe because it dereferences raw pointers and assumes the caller provides a valid pointer to an AsSystemInfo.
```

--------------------------------

### as_review_get_type

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the type of a review.

```APIDOC
## as_review_get_type

### Description
Gets the type of a review.

### Function Signature
`AsReviewType as_review_get_type(AsReview *review)`

### Parameters
- **review** (AsReview*) - The review object.

### Returns
AsReviewType - The review type.
```

--------------------------------

### as_component_box_new_simple

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/index.html

Creates a new AsComponentBox with a simple configuration. This is a low-level FFI function for quick creation.

```APIDOC
## as_component_box_new_simple

### Description
Creates a new AsComponentBox with a simple configuration. This is a low-level FFI function for quick creation.

### Function
`unsafe fn as_component_box_new_simple(...)`

### Parameters
- **flags** (enum) - Initial flags for the box.

### Returns
- **pointer** - A pointer to the newly created AsComponentBox.

### Safety
This function is unsafe because it returns a raw pointer that must be manually managed.
```

--------------------------------

### as_review_get_summary

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the summary of a review.

```APIDOC
## as_review_get_summary

### Description
Gets the summary of a review.

### Function Signature
`const gchar *as_review_get_summary(AsReview *review)`

### Parameters
- **review** (AsReview*) - The review object.

### Returns
const gchar* - The summary string.
```

--------------------------------

### as_review_get_rating

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the rating of a review.

```APIDOC
## as_review_get_rating

### Description
Gets the rating of a review.

### Function Signature
`guint as_review_get_rating(AsReview *review)`

### Parameters
- **review** (AsReview*) - The review object.

### Returns
guint - The rating value.
```

--------------------------------

### Suggested::new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/struct.Suggested.html

Creates a new Suggested instance. This is the primary constructor for the Suggested struct.

```APIDOC
## Suggested::new

### Description
Creates a new `Suggested` instance.

### Method
`pub fn new() -> Suggested`

### Parameters
None

### Returns
A new `Suggested` instance.

### Example
```rust
let suggested = Suggested::new();
```
```

--------------------------------

### as_review_get_priority

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the priority of a review.

```APIDOC
## as_review_get_priority

### Description
Gets the priority of a review.

### Function Signature
`guint as_review_get_priority(AsReview *review)`

### Parameters
- **review** (AsReview*) - The review object.

### Returns
guint - The priority value.
```

--------------------------------

### as_system_info_get_os_homepage

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the OS homepage URL.

```APIDOC
## as_system_info_get_os_homepage

### Description
Gets the OS homepage URL.

### Function
`as_system_info_get_os_homepage`

### Parameters
- `system_info` (AsSystemInfo*) - The system info object.

### Returns
The OS homepage URL.
```

--------------------------------

### as_developer_new

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Creates a new AsDeveloper object.

```APIDOC
## as_developer_new

### Description
Creates a new `AsDeveloper` object.

### Function Signature
`as_developer_new() -> *mut AsDeveloper`

### Parameters
None.

### Returns
- **AsDeveloper*** - A newly created `AsDeveloper` object.
```

--------------------------------

### as_review_get_locale

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the locale of a review.

```APIDOC
## as_review_get_locale

### Description
Gets the locale of a review.

### Function Signature
`const gchar *as_review_get_locale(AsReview *review)`

### Parameters
- **review** (AsReview*) - The review object.

### Returns
const gchar* - The locale string.
```

--------------------------------

### as_review_get_id

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the ID of a review.

```APIDOC
## as_review_get_id

### Description
Gets the ID of a review.

### Function Signature
`const gchar *as_review_get_id(AsReview *review)`

### Parameters
- **review** (AsReview*) - The review object.

### Returns
const gchar* - The ID string.
```

--------------------------------

### as_component_get_suggested

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/index.html

Retrieves the suggested components for this component. This is a raw FFI function.

```APIDOC
## as_component_get_suggested

### Description
Retrieves the suggested components for this component.

### Function Signature
`as_component_get_suggested`

### Parameters
- **component** (pointer) - The AsComponent instance.

### Returns
- **suggested** (list) - List of suggested components.

```

--------------------------------

### fn set_explanation(&self, explanation: &str)

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/prelude/trait.ValidatorIssueExt.html

Set explanatory text for this issue.

```APIDOC
## fn set_explanation(&self, explanation: &str)

### Description
Set explanatory text for this issue.

### Parameters
- `explanation` (&str) - Required - The explanation.

```

--------------------------------

### as_review_get_flags

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the flags of a review.

```APIDOC
## as_review_get_flags

### Description
Gets the flags of a review.

### Function Signature
`AsReviewFlags as_review_get_flags(AsReview *review)`

### Parameters
- **review** (AsReview*) - The review object.

### Returns
AsReviewFlags - The flags.
```

--------------------------------

### fn videos_all(&self) -> Vec<Video>

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream/prelude/trait.ScreenshotExt.html

Returns an array of all screencast videos we have, regardless of their size and locale.

```APIDOC
## fn videos_all(&self) -> Vec<Video>

### Description
Returns an array of all screencast videos we have, regardless of their size and locale.

### Method
videos_all

### Returns
- `Vec<Video>` - An array of videos.

```

--------------------------------

### as_review_get_description

Source: https://world.pages.gitlab.gnome.org/Rust/libappstream-rs/git/docs/libappstream_sys/all.html

Gets the description of a review.

```APIDOC
## as_review_get_description

### Description
Gets the description of a review.

### Function Signature
`const gchar *as_review_get_description(AsReview *review)`

### Parameters
- **review** (AsReview*) - The review object.

### Returns
const gchar* - The description string.
```
Tokens:
Raw