Daisuke Maki > Senna-0.51 > Senna::RC

Download:
Senna-0.51.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Source  

NAME ^

Senna::RC - Wrapper for sen_rc

SYNOPSIS ^

  use Senna::RC;
  use Senna::Constants qw(SEN_SUCCESS);

  my $rc = Senna::RC->new(SEN_SUCCESS);
  if ($rc) {
     print "success!\n";
  }

  $rc->value;

DESCRIPTION ^

Senna::RC is a simple wrapper around sen_rc that allows you to evaluate results from Senna functions in Perl-ish boolean context, like

  if ($index->insert($query)) {
    ...
  }

Or, you can choose to access the internal sen_rc value:

  my $rc = $index->insert($query);
  if ($rc->value == SEN_SUCCESS) {
    ...
  }

METHODS ^

new

Creates a new Senna::RC object

value

Returns the internal sen_rc value

AUTHOR ^

Copyright (C) 2005 - 2006 by Daisuke Maki <dmaki@cpan.org>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.

Development funded by Brazil Ltd. <http://dev.razil.jp/project/senna/>

syntax highlighting: