Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
GI.Dazzle.Objects.FuzzyIndexBuilder
Description
No description available in the introspection data.
Synopsis
- newtype FuzzyIndexBuilder = FuzzyIndexBuilder (ManagedPtr FuzzyIndexBuilder)
- class (GObject o, IsDescendantOf FuzzyIndexBuilder o) => IsFuzzyIndexBuilder o
- toFuzzyIndexBuilder :: (MonadIO m, IsFuzzyIndexBuilder o) => o -> m FuzzyIndexBuilder
- fuzzyIndexBuilderGetCaseSensitive :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> m Bool
- fuzzyIndexBuilderGetDocument :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> Word64 -> m GVariant
- fuzzyIndexBuilderInsert :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> Text -> GVariant -> Word32 -> m Word64
- fuzzyIndexBuilderNew :: (HasCallStack, MonadIO m) => m FuzzyIndexBuilder
- fuzzyIndexBuilderSetCaseSensitive :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> Bool -> m ()
- fuzzyIndexBuilderSetMetadata :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> Text -> GVariant -> m ()
- fuzzyIndexBuilderSetMetadataString :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> Text -> Text -> m ()
- fuzzyIndexBuilderSetMetadataUint32 :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> Text -> Word32 -> m ()
- fuzzyIndexBuilderSetMetadataUint64 :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> Text -> Word64 -> m ()
- fuzzyIndexBuilderWrite :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a, IsFile b, IsCancellable c) => a -> b -> Int32 -> Maybe c -> m ()
- fuzzyIndexBuilderWriteAsync :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a, IsFile b, IsCancellable c) => a -> b -> Int32 -> Maybe c -> Maybe AsyncReadyCallback -> m ()
- fuzzyIndexBuilderWriteFinish :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a, IsAsyncResult b) => a -> b -> m ()
- constructFuzzyIndexBuilderCaseSensitive :: (IsFuzzyIndexBuilder o, MonadIO m) => Bool -> m (GValueConstruct o)
- getFuzzyIndexBuilderCaseSensitive :: (MonadIO m, IsFuzzyIndexBuilder o) => o -> m Bool
- setFuzzyIndexBuilderCaseSensitive :: (MonadIO m, IsFuzzyIndexBuilder o) => o -> Bool -> m ()
Exported types
newtype FuzzyIndexBuilder Source #
Memory-managed wrapper type.
Constructors
FuzzyIndexBuilder (ManagedPtr FuzzyIndexBuilder) |
Instances
class (GObject o, IsDescendantOf FuzzyIndexBuilder o) => IsFuzzyIndexBuilder o Source #
Type class for types which can be safely cast to FuzzyIndexBuilder
, for instance with toFuzzyIndexBuilder
.
Instances
(GObject o, IsDescendantOf FuzzyIndexBuilder o) => IsFuzzyIndexBuilder o Source # | |
Defined in GI.Dazzle.Objects.FuzzyIndexBuilder |
toFuzzyIndexBuilder :: (MonadIO m, IsFuzzyIndexBuilder o) => o -> m FuzzyIndexBuilder Source #
Cast to FuzzyIndexBuilder
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, insert, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure, write, writeAsync, writeFinish.
Getters
getCaseSensitive, getData, getDocument, getProperty, getQdata.
Setters
setCaseSensitive, setData, setDataFull, setMetadata, setMetadataString, setMetadataUint32, setMetadataUint64, setProperty.
getCaseSensitive
fuzzyIndexBuilderGetCaseSensitive :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> m Bool Source #
No description available in the introspection data.
getDocument
fuzzyIndexBuilderGetDocument Source #
Arguments
:: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) | |
=> a | |
-> Word64 | |
-> m GVariant | Returns: A |
Returns the document that was inserted in a previous call to
fuzzyIndexBuilderInsert
.
insert
fuzzyIndexBuilderInsert Source #
Arguments
:: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) | |
=> a |
|
-> Text |
|
-> GVariant |
|
-> Word32 |
|
-> m Word64 | Returns: The document id registered for |
Inserts document
into the index using key
as the lookup key.
If a matching document (checked by hashing document
) has already
been inserted, only a single instance of the document will be stored.
If document
is floating, it will be consumed.
priority
may be used to group results by priority. Priority must be
less than 256.
new
fuzzyIndexBuilderNew :: (HasCallStack, MonadIO m) => m FuzzyIndexBuilder Source #
No description available in the introspection data.
setCaseSensitive
fuzzyIndexBuilderSetCaseSensitive :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> Bool -> m () Source #
No description available in the introspection data.
setMetadata
fuzzyIndexBuilderSetMetadata :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> Text -> GVariant -> m () Source #
No description available in the introspection data.
setMetadataString
fuzzyIndexBuilderSetMetadataString :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> Text -> Text -> m () Source #
No description available in the introspection data.
setMetadataUint32
fuzzyIndexBuilderSetMetadataUint32 :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> Text -> Word32 -> m () Source #
No description available in the introspection data.
setMetadataUint64
fuzzyIndexBuilderSetMetadataUint64 :: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) => a -> Text -> Word64 -> m () Source #
No description available in the introspection data.
write
fuzzyIndexBuilderWrite Source #
Arguments
:: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a, IsFile b, IsCancellable c) | |
=> a | |
-> b | |
-> Int32 | |
-> Maybe c | |
-> m () | (Can throw |
No description available in the introspection data.
writeAsync
fuzzyIndexBuilderWriteAsync Source #
Arguments
:: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a, IsFile b, IsCancellable c) | |
=> a |
|
-> b |
|
-> Int32 |
|
-> Maybe c |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Builds and writes the index to file
. The file format is a
GVariant on disk and can be loaded and searched using
FuzzyIndex
.
writeFinish
fuzzyIndexBuilderWriteFinish Source #
Arguments
:: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a, IsAsyncResult b) | |
=> a | |
-> b | |
-> m () | (Can throw |
No description available in the introspection data.
Properties
caseSensitive
No description available in the introspection data.
constructFuzzyIndexBuilderCaseSensitive :: (IsFuzzyIndexBuilder o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “case-sensitive
” property. This is rarely needed directly, but it is used by new
.
getFuzzyIndexBuilderCaseSensitive :: (MonadIO m, IsFuzzyIndexBuilder o) => o -> m Bool Source #
Get the value of the “case-sensitive
” property.
When overloading is enabled, this is equivalent to
get
fuzzyIndexBuilder #caseSensitive
setFuzzyIndexBuilderCaseSensitive :: (MonadIO m, IsFuzzyIndexBuilder o) => o -> Bool -> m () Source #
Set the value of the “case-sensitive
” property.
When overloading is enabled, this is equivalent to
set
fuzzyIndexBuilder [ #caseSensitive:=
value ]