gi-dazzle-1.0.2: libdazzle bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Dazzle.Objects.FuzzyIndexBuilder

Description

No description available in the introspection data.

Synopsis

Exported types

newtype FuzzyIndexBuilder Source #

Memory-managed wrapper type.

Constructors

FuzzyIndexBuilder (ManagedPtr FuzzyIndexBuilder) 

Instances

Instances details
Eq FuzzyIndexBuilder Source # 
Instance details

Defined in GI.Dazzle.Objects.FuzzyIndexBuilder

GObject FuzzyIndexBuilder Source # 
Instance details

Defined in GI.Dazzle.Objects.FuzzyIndexBuilder

ManagedPtrNewtype FuzzyIndexBuilder Source # 
Instance details

Defined in GI.Dazzle.Objects.FuzzyIndexBuilder

TypedObject FuzzyIndexBuilder Source # 
Instance details

Defined in GI.Dazzle.Objects.FuzzyIndexBuilder

Methods

glibType :: IO GType

HasParentTypes FuzzyIndexBuilder Source # 
Instance details

Defined in GI.Dazzle.Objects.FuzzyIndexBuilder

IsGValue (Maybe FuzzyIndexBuilder) Source #

Convert FuzzyIndexBuilder to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Dazzle.Objects.FuzzyIndexBuilder

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe FuzzyIndexBuilder -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe FuzzyIndexBuilder)

type ParentTypes FuzzyIndexBuilder Source # 
Instance details

Defined in GI.Dazzle.Objects.FuzzyIndexBuilder

type ParentTypes FuzzyIndexBuilder = '[Object]

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

Instances details
(GObject o, IsDescendantOf FuzzyIndexBuilder o) => IsFuzzyIndexBuilder o Source # 
Instance details

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

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 GVariant

Returns the document that was inserted in a previous call to fuzzyIndexBuilderInsert.

insert

fuzzyIndexBuilderInsert Source #

Arguments

:: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a) 
=> a

self: A FuzzyIndexBuilder

-> Text

key: The UTF-8 encoded key for the document

-> GVariant

document: The document to store

-> Word32

priority: An optional priority for the keyword.

-> m Word64

Returns: The document id registered for document.

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 GError)

No description available in the introspection data.

writeAsync

fuzzyIndexBuilderWriteAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsFuzzyIndexBuilder a, IsFile b, IsCancellable c) 
=> a

self: A FuzzyIndexBuilder

-> b

file: A File to write the index to

-> Int32

ioPriority: The priority for IO operations

-> Maybe c

cancellable: An optional Cancellable or Nothing

-> Maybe AsyncReadyCallback

callback: A callback for completion or Nothing

-> 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 GError)

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 ]