Struct slint_interpreter::ComponentCompiler
source · [−]pub struct ComponentCompiler { /* private fields */ }
Expand description
ComponentCompiler is the entry point to the Slint interpreter that can be used to load .slint files or compile them on-the-fly from a string.
Implementations
sourceimpl ComponentCompiler
impl ComponentCompiler
sourcepub fn set_include_paths(&mut self, include_paths: Vec<PathBuf>)
pub fn set_include_paths(&mut self, include_paths: Vec<PathBuf>)
Sets the include paths used for looking up .slint
imports to the specified vector of paths.
sourcepub fn include_paths(&self) -> &Vec<PathBuf>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
pub fn include_paths(&self) -> &Vec<PathBuf>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Returns the include paths the component compiler is currently configured with.
sourcepub fn style(&self) -> Option<&String>
pub fn style(&self) -> Option<&String>
Returns the widget style the compiler is currently using when compiling .slint files.
sourcepub fn set_file_loader(
&mut self,
file_loader_fallback: impl Fn(&Path) -> Pin<Box<dyn Future<Output = Option<Result<String>>>>> + 'static
)
pub fn set_file_loader(
&mut self,
file_loader_fallback: impl Fn(&Path) -> Pin<Box<dyn Future<Output = Option<Result<String>>>>> + 'static
)
Sets the callback that will be invoked when loading imported .slint files. The specified
file_loader_callback
parameter will be called with a canonical file path as argument
and is expected to return a future that, when resolved, provides the source code of the
.slint file to be imported as a string.
If an error is returned, then the build will abort with that error.
If None is returned, it means the normal resolution algorithm will proceed as if the hook
was not in place (i.e: load from the file system following the include paths)
sourcepub fn diagnostics(&self) -> &Vec<Diagnostic>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
pub fn diagnostics(&self) -> &Vec<Diagnostic>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Returns the diagnostics that were produced in the last call to Self::build_from_path
or Self::build_from_source
.
sourcepub async fn build_from_path<P: AsRef<Path>>(
&mut self,
path: P
) -> Option<ComponentDefinition>
pub async fn build_from_path<P: AsRef<Path>>(
&mut self,
path: P
) -> Option<ComponentDefinition>
Compile a .slint file into a ComponentDefinition
Returns the compiled ComponentDefinition
if there were no errors.
Any diagnostics produced during the compilation, such as warnings or errors, are collected
in this ComponentCompiler and can be retrieved after the call using the Self::diagnostics()
function. The print_diagnostics
function can be used to display the diagnostics
to the users.
Diagnostics from previous calls are cleared when calling this function.
If the path is "-"
, the file will be read from stdin.
This function is async
but in practice, this is only asynchronous if
Self::set_file_loader
was called and its future is actually asynchronous.
If that is not used, then it is fine to use a very simple executor, such as the one
provided by the spin_on
crate
sourcepub async fn build_from_source(
&mut self,
source_code: String,
path: PathBuf
) -> Option<ComponentDefinition>
pub async fn build_from_source(
&mut self,
source_code: String,
path: PathBuf
) -> Option<ComponentDefinition>
Compile some .slint code into a ComponentDefinition
The path
argument will be used for diagnostics and to compute relative
paths while importing.
Any diagnostics produced during the compilation, such as warnings or errors, are collected
in this ComponentCompiler and can be retrieved after the call using the Self::diagnostics()
function. The print_diagnostics
function can be used to display the diagnostics
to the users.
Diagnostics from previous calls are cleared when calling this function.
This function is async
but in practice, this is only asynchronous if
Self::set_file_loader
is set and its future is actually asynchronous.
If that is not used, then it is fine to use a very simple executor, such as the one
provided by the spin_on
crate
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for ComponentCompiler
impl !Send for ComponentCompiler
impl !Sync for ComponentCompiler
impl Unpin for ComponentCompiler
impl !UnwindSafe for ComponentCompiler
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<R, P> ReadPrimitive<R> for P where
R: Read + ReadEndian<P>,
P: Default,
impl<R, P> ReadPrimitive<R> for P where
R: Read + ReadEndian<P>,
P: Default,
sourcefn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian()
.
sourcefn read_from_big_endian(read: &mut R) -> Result<Self, Error>
fn read_from_big_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian()
.
sourcefn read_from_native_endian(read: &mut R) -> Result<Self, Error>
fn read_from_native_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian()
.